List sprints
list_sprintsRetrieve Scrum sprints to obtain IDs needed for assigning work packages and to review planning, active, or completed sprint status.
Instructions
List sprints (Scrum timeboxes) you can plan work packages into.
Use it to turn "Sprint 11" into the sprint id that
create_work_package/update_work_package consume via their
sprint parameter, or to review a project's sprint plan with its
in_planning/active/completed states.
Returns the standard list envelope: items of {id, name, description, start_date, finish_date, workspace, status} plus
pagination and notes. A project-scoped listing is fetched in
full, so has_more is false; the instance-wide listing is paginated.
Pitfalls: sprints are not versions (17.3+): finish_date is the wire finishDate
and status is the sprint lifecycle. Assign work with
update_work_package(sprint=...); the API has no sprint write endpoint.
Cross-references: get_sprint for one sprint in full;
list_versions for releases and milestones; list_work_packages
with sprint_ids to see what is IN a sprint.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page number. | |
| page_size | No | Sprints per page (max 100). | |
| project_id | No | Numeric project id or URL identifier to list the sprints of that project (native or shared). Omit it to list every sprint visible to you across the instance. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sums | No | Present only when show_sums was requested. | |
| items | No | The page of results. | |
| notes | No | Degradation markers: capped aggregations, unavailable modules, … | |
| groups | No | Present only when group_by was requested. | |
| pagination | Yes | Total/page/page_size/has_more. |