List sprints

GEThttps://<your-url>/api/v2/sprints

MCP id sprints.indexAlso on this path: POST Create a sprint

Returns the organisation's sprints in each project's display order, with the id as the tiebreaker.

Token scope: api:read:project_management
Without it: 403 insufficient-token-scope.
Permission: project_management::view_active_sprint
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket. view=detail makes it 3. Adds: each include +1, q +2.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One project's upcoming sprints, in display order

curl -G \
  'https://<your-url>/api/v2/sprints' \
  --data-urlencode 'filter[project_id]=1' \
  --data-urlencode 'filter[is_active]=false' \
  --data-urlencode 'filter[completed_at][null]=true' \
  --data-urlencode 'sort=order' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/sprints?filter[project_id]=1&filter[is_active]=false&filter[completed_at][null]=true&sort=order', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/sprints?filter[project_id]=1&filter[is_active]=false&filter[completed_at][null]=true&sort=order');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/sprints?filter[project_id]=1&filter[is_active]=false&filter[completed_at][null]=true&sort=order',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": [
    {
      "id": 1,
      "project_id": 1,
      "name": "Sprint 14",
      "description": "Finish the invoicing export.",
      "start_date": "2026-03-02",
      "end_date": "2026-03-13",
      "started_at": "2026-03-04T09:15:00Z",
      "completed_at": "2026-03-04T09:15:00Z",
      "is_active": false,
      "order": 1,
      "work_items_count": 1,
      "created_at": "2026-03-04T09:15:00Z"
    }
  ],
  "meta": {
    "page": {
      "per_page": 1,
      "next_cursor": "…",
      "prev_cursor": "…",
      "total": 1,
      "current_page": 1,
      "last_page": 1
    }
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1",
    "next": "https://<your-url>/api/v2/work-items/1",
    "prev": "https://<your-url>/api/v2/work-items/1"
  }
}

3 more fields, listed under Response

The list covers the whole organisation and interleaves projects, because order is unique within a project only; narrow it with filter[project_id]. A sprint's state is derived rather than stored, so there is no filter[state]; compose it instead: filter[is_active]=true&filter[completed_at][null]=true is the running sprint, filter[is_active]=false&filter[completed_at][null]=true the upcoming ones, and filter[completed_at][null]=false the history. Listing additionally requires project_management::manage_sprints.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

32 parameters in 6 groups

Views

viewstring

Which field set to render.

summarydefaultdetail

Pagination

per_pageinteger1 to 100

Rows per page. At most 25 when include names a to-many relation; a larger value is 400 invalid-query-parameter.

Default: 25

cursorstring

Opaque keyset cursor from a previous page's links.next. Never construct one by hand.

pageinteger1 to 1000

Opt in to page-number paging: 1-based, at most 1000. Omit it, the default, to page by opaque cursor, which is what links.next hands you. Cannot be combined with cursor. Published only on collections that count their rows on every request. This collection's default sort is a display position that changes whenever someone drags the list into a new order in plnnrly, so a page number can skip or repeat a row if the list is reordered between two page requests. These collections rarely exceed one page; for a stable walk, send sort=id and follow links.next without page.

Filters

=: equals
[in]: any of a comma-separated list
[null]: true or false: whether it is empty
[gte][lte][lt]: at least, at most, less than

filter[completed_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lte][null]

When the sprint was actually completed. filter[completed_at][null]=false is every completed sprint and filter[completed_at][null]=true every sprint still open.

Whether the field is null.

filter[created_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Creation timestamp. Pair with sort=id for a stable full export.

filter[end_date]date (YYYY-MM-DD)=[gte][lte][null]

Planned last day of the sprint.

Whether the field is null.

filter[is_active]boolean

Whether the sprint is the project's running one. Combine with filter[completed_at][null] to express a sprint state; this filter alone does not distinguish upcoming from completed.

filter[project_id]integer=[in]

Narrow the list to one project's sprints, or to several with in.

A comma-separated list of at most 100 values.

filter[start_date]date (YYYY-MM-DD)=[gte][lte][null]

Planned first day of the sprint.

Whether the field is null.

filter[started_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lte][null]

When the sprint was actually started. filter[started_at][null]=true is every sprint that has never run.

Whether the field is null.

filter[updated_at]timestamp (YYYY-MM-DDThh:mm:ssZ)=[gte][lt]

Last-write timestamp. Use for incremental sync.

Search

qstring

Free-text search over name. At most one substring match per request: q together with a contains filter is 400 invalid-query-parameter.

Sorting

sortstring

Up to three keys, comma-separated, each optionally prefixed with - for descending.

Default: order

Key	Sorts by
`order`	Display position within the project, as ordered in plnnrly. The default sort; the id breaks ties, because positions are unique within a project only.
`name`	Sprint name, A→Z.
`start_date`	Planned first day of the sprint.
`end_date`	Planned last day of the sprint.
`started_at`	When the sprint was actually started.
`completed_at`	When the sprint was actually completed. Newest first, with `-`, is the sprint-history order.
`id`	Id, ascending. An id never changes, so use this for a stable full export.
`updated_at`	Last-write timestamp; pair with the id tiebreaker for sync.

Prefix a key with - for descending.

Includes

includestring

Comma-separated names to inline, at most five.

Path	Adds	Cost
`project`	The project this sprint belongs to. Requires the projects prefix's read grant and a token scope covering it; without both it renders as a bare id reference.	+1

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a page of SprintList rows.

dataarray of SprintList

The rows, each a SprintList.

meta.pagePage

per_page, next_cursor, prev_cursor, total, current_page, last_page.

linksPageLinks

self, next, prev.

Each row is a SprintList: 15 fields.

Headers

ETag: A weak validator (W/"…") of the rendered page.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning