Project workspace

list-sprints-tool

List sprints for a project, optionally filtered by state.

Returns sprints for one project. Sprint state is derived from is_active plus the started_at / completed_at timestamps:

  • upcoming — never started.
  • activeis_active=true, not completed.
  • completed — has a completed_at.

Inputs

NameTypeRequiredDescription
project_idintegeryesProject to list sprints for.
statestringnoOne of upcoming, active, completed. Omit to return all sprints.

Permissions

  • project_management::view_backlog.

Example

{
  "project_id": 3,
  "state": "active"
}

Response

{
  "data": [
    {
      "id": 7,
      "name": "Sprint 24",
      "description": "Stripe migration cleanup",
      "state": "active",
      "is_active": true,
      "start_date": "2026-06-01",
      "end_date": "2026-06-15",
      "started_at": "2026-06-01T08:00:00+00:00",
      "completed_at": null,
      "order": 24,
      "project_id": 3
    }
  ],
  "total": 1
}

Errors

  • An unknown project_id returns a validation error.
  • An unknown state returns a validation error.
  • A caller without project_management::view_backlog receives an authorization error.

On this page