Sprints

REST API — All endpoints require authentication via Bearer token. Include Authorization: Bearer {token} in every request. Tokens are managed in GitScrum Settings → API. Base URL: https://services.gitscrum.com — All request paths in this documentation are relative to this base URL.

Sprints are time-boxed iterations used to plan and deliver work. Each sprint contains tasks and provides built-in metrics for tracking velocity, burndown, and team performance.

List Sprints

Returns sprints for a project.

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

Query Parameters

Example Request

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

Example Response

{
  "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
      }
    }
  ]
}

Get Sprint

Returns full details for a single sprint.

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

Path Parameters

All Sprints (Cross-Workspace)

Returns sprints across all workspaces the authenticated user has access to.

GET /sprints/all-workspaces

Create Sprint

Creates a new sprint.

POST /sprints

Request Body

Example Request

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
  }'

Update Sprint

Updates an existing sprint.

PUT /sprints/{slug}

Request Body

Accepts companyslug, projectslug, and the same optional fields as Create Sprint.

Sprint KPIs

Returns key performance indicators for the sprint.

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

Sprint Stats

Returns sprint statistics.

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

Sprint Reports

Returns sprint reports with optional chart data.

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

Query Parameters

Sprint Progress

Returns current sprint progress.

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

Sprint Metrics

Returns detailed sprint metrics.

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

Delete Sprint

Permanently deletes a sprint. Tasks in the sprint are preserved but unlinked.

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

Path Parameters

Field Reference