Documentation
Product GuideREST API ReferenceMCP Server for AI AgentsWebhooks & EventsIntegrations
READ

list_sprints

Lists a project's sprints in number order with their dates, status, capacity, the points committed to and finished, the velocity, the item count and who started and closed them, narrowed by status, open or words; a guest token reads none.

Read the sprints of a project before you pick up or plan work. Each row carries the number and name, the goal, starts_on, ends_on, duration_days and days_left, the status (planned, committing while the team votes, active once it runs, completed or cancelled), capacity_points and capacity_hours, committed_points (the scope's points when the team committed), completed_points and velocity once closed, the retrospective, item_count, who started it and when, who closed it and when, and the commitment's approval stamps. Narrow with status, with open true for the sprints still ahead or running, or with search (words the name must contain); page with limit and page. The running sprint is the one with status active, and there is at most one; read its scope with get_sprint. A client guest's token reads no sprints.

Requires ability

sprint:view-any

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

Annotations

Read-only

It reads and never changes anything.

Arguments

project_id*string

UUID of the project.

statusstringoptional

Narrow to one status.

plannedcommittingactivecompletedcancelled
openbooleanoptional

True for the sprints that are planned, awaiting commitment or running.

searchstringoptional

Words the name must contain.

limitintegeroptional

Rows per page, 1 to 100; 25 by default.

pageintegeroptional

The page, from 1.

What it returns

{  "data": [    {      "id": "8b3f6a02-2d5c-4e9f-8c4b-7d8e9f0a1b22",      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",      "number": 3,      "name": "Sprint 3",      "goal": "<p>Customers reset their password and see their orders.</p>",      "starts_on": "2026-11-09",      "ends_on": "2026-11-22",      "duration_days": 14,      "days_left": 9,      "status": "active",      "capacity_points": 21,      "capacity_hours": 160,      "committed_points": 21,      "completed_points": null,      "velocity": null,      "retrospective": null,      "item_count": 8,      "started_by": "3f8a1c2e-7b4d-4e5f-9a6b-1c2d3e4f5a6b",      "starter_name": "Pat Manager",      "started_at": "2026-11-09T09:00:00+00:00",      "closed_by": null,      "closer_name": null,      "closed_at": null,      "version": 1,      "approved_at": "2026-11-09T09:00:00+00:00",      "approved_revision_id": "0e1f2a3b-4c5d-4e6f-8a7b-9c0d1e2f3a4b",      "created_at": "2026-11-03T08:00:00+00:00",      "updated_at": "2026-11-09T09:00:00+00:00"    }  ],  "meta": { "page": 1, "limit": 25, "total": 3, "has_more": false }}

How it fails

VALIDATION_FAILED

unknown status (the response lists the supported values), or limit outside 1..100.

RESOURCE_NOT_FOUND

unknown project_id, or a project outside the token's scope.

FORBIDDEN

the token is a client guest's, or the holder's role on the project does not carry sprint:view-any.

TOKEN_MISSING_ABILITY

token lacks sprint:view-any.

Related

get_sprintone sprint with the work items it holds and its points.list_work_itemsthe backlog, narrowed to one sprint with sprint_id or to the unplanned items with unplanned.update_work_itemplan an item into a sprint through its sprint_id.Sprints APIthe same list over REST, and the writes.

How is this guide?

Last updated on