Sprints

REST API — Todos os endpoints requerem autenticação via Bearer token. Inclua Authorization: Bearer {token} em cada requisição. Os tokens são gerenciados em Configurações do GitScrum → API. Base URL: https://services.gitscrum.com — Todos os caminhos de requisição nesta documentação são relativos a esta URL base.

Sprints são iterações limitadas no tempo usadas para planejar e entregar trabalho. Cada sprint contém tarefas e fornece métricas integradas para acompanhar velocidade, burndown e desempenho da equipe.

Listar Sprints

Retorna sprints de um projeto.

GET /sprints?company_slug={slug}&project_slug={slug}

Parâmetros de Query

Exemplo de Requisição

curl -X GET "https://services.gitscrum.com/sprints?company_slug=acme&project_slug=web-app" \
  -H "Authorization: Bearer {token}"

Exemplo de Resposta

{
  "data": [
    {
      "slug": "sprint-12",
      "title": "Sprint 12",
      "description": "Authentication and onboarding improvements",
      "date_start": "2026-02-03",
      "date_finish": "2026-02-14",
      "color": "4A90D9",
      "is_private": false,
      "close_on_finish": true,
      "stats": {
        "tasks_count": 18,
        "completed_count": 7,
        "progress_percentage": 39
      }
    }
  ]
}

Obter Sprint

Retorna detalhes completos de um único sprint.

GET /sprints/{slug}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

Todos os Sprints (Cross-Workspace)

Retorna sprints de todos os workspaces aos quais o usuário autenticado tem acesso.

GET /sprints/all-workspaces

Criar Sprint

Cria um novo sprint.

POST /sprints

Corpo da Requisição

Exemplo de Requisição

curl -X POST "https://services.gitscrum.com/sprints" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Sprint 13",
    "company_slug": "acme",
    "project_slug": "web-app",
    "date_start": "2026-02-17",
    "date_finish": "2026-02-28",
    "close_on_finish": true
  }'

Atualizar Sprint

Atualiza um sprint existente.

PUT /sprints/{slug}

Corpo da Requisição

Aceita companyslug, projectslug e os mesmos campos opcionais de Criar Sprint.

KPIs do Sprint

Retorna indicadores-chave de desempenho do sprint.

GET /sprints/{slug}/kpis?company_slug={slug}&project_slug={slug}

Estatísticas do Sprint

Retorna estatísticas do sprint.

GET /sprints/{slug}/stats?company_slug={slug}&project_slug={slug}

Relatórios do Sprint

Retorna relatórios do sprint com dados de gráficos opcionais.

GET /sprints/{slug}/reports?company_slug={slug}&project_slug={slug}

Parâmetros de Query

Progresso do Sprint

Retorna o progresso atual do sprint.

GET /sprints/{slug}/progress?company_slug={slug}&project_slug={slug}

Métricas do Sprint

Retorna métricas detalhadas do sprint.

GET /sprints/{slug}/metrics?company_slug={slug}&project_slug={slug}

Excluir Sprint

Exclui permanentemente um sprint. As tarefas do sprint são preservadas, mas desvinculadas.

DELETE /sprints/{slug}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

Referência de Campos