Read a sprint

GEThttps://<your-url>/api/v2/sprints/{sprint}

MCP id sprints.showAlso on this path: PATCH Update a sprint, DELETE Delete a sprint

Returns one sprint in the detail view.

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.
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 sprint with its project expanded

curl -G \
  'https://<your-url>/api/v2/sprints/1' \
  --data-urlencode 'include=project' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/sprints/1?include=project', {
  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/1?include=project');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/sprints/1?include=project',
    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": {
    "actions": [
      "complete"
    ]
  }
}

3 more fields, listed under Response

The state is derived, not stored: completed_at non-null means completed, otherwise is_active true means active, otherwise upcoming. work_items_count is the number of items on the sprint and links.work_items is the URL that lists them. Reading additionally requires project_management::manage_sprints.

Path parameters

sprintintegerRequired

The Sprint's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

metaarray of string

Optional meta members to compute for this response.

actions

New values may be added.

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 Sprint in the detail view.

Headers

ETag: A strong validator of exactly this representation.
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