Complete a sprint

POSThttps://<your-url>/api/v2/sprints/{sprint}/actions/complete

MCP id sprints.actions.complete

Closes a sprint: clears is_active and stamps completed_at with the current time, then disposes of the sprint's unresolved work items (those whose workflow status is not a resolution) according to unresolved_work_items.

Token scope: api:write:project_management
Without it: 403 insufficient-token-scope.
Permission: project_management::manage_sprints
Without it: 403 insufficient-permission.
Rate cost: 1 unit, write bucket. A write costs the same whatever view you ask for.
Also: Accepts Idempotency-Key. Accepts If-Match. Never cached: private, no-store. Unknown body keys are refused, never dropped.

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

Request

Example: Close the sprint and roll unfinished work into the next one

curl -X POST \
  'https://<your-url>/api/v2/sprints/1/actions/complete' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "unresolved_work_items": "move_to_next_sprint",
    "next_sprint_id": 1
  }'

const response = await fetch('https://<your-url>/api/v2/sprints/1/actions/complete', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "unresolved_work_items": "move_to_next_sprint",
    "next_sprint_id": 1
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('Idempotency-Key', '<key>')
    ->post('https://<your-url>/api/v2/sprints/1/actions/complete', [
        'unresolved_work_items' => 'move_to_next_sprint',
        'next_sprint_id' => 1,
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/sprints/1/actions/complete',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'unresolved_work_items': 'move_to_next_sprint', 'next_sprint_id': 1},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "project_id": 1,
    "name": "Sprint 14",
    "description": "…",
    "start_date": "2026-03-04",
    "end_date": "2026-03-04",
    "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"
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/state-conflict",
  "title": "State conflict",
  "status": 409,
  "detail": "The target status is not reachable from this work item's current status.",
  "instance": "/api/v2/work-items/812/actions/transition",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "conflict": {
    "reason": "illegal_transition",
    "from_workflow_status_id": 3,
    "to_workflow_status_id": 9
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/precondition-failed",
  "title": "Precondition failed",
  "status": 412,
  "detail": "The record changed since the version named in If-Match. Re-read it and retry.",
  "instance": "/api/v2/work-items/812",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "current_version": 12
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "3 fields failed validation.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "errors": [
    {
      "pointer": "/date",
      "code": "date_format",
      "detail": "The date does not match the format Y-m-d."
    },
    {
      "pointer": "/minutes",
      "code": "min",
      "detail": "The minutes must be at least 1."
    },
    {
      "pointer": "/description",
      "code": "required",
      "detail": "The description field is required."
    }
  ]
}

3 more fields, listed under Response

Resolved items always stay on the completed sprint, whichever strategy is chosen, so the closed sprint keeps its delivery history. move_to_next_sprint additionally requires next_sprint_id, which must name a not-yet-completed sprint on the same project other than this one; anything else is 422 unprocessable-relationship pointing at /next_sprint_id. A sprint that is already completed refuses with 409 state-conflict and conflict.reason already_completed, and one that was never started refuses the same way with not_started. Each moved item is saved on its own, so its audit trail records the move and its version is bumped (a client holding their ETags must re-read them), but no per-item notification is sent. Returns the sprint in the detail view; work_items_count reflects what is left on it.

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

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-Matchstring

The ETag a write is conditional on. A stale validator is 412 precondition-failed.

Idempotency-Keystring≤ 255

A caller-chosen key that makes this POST safe to retry. Replaying it returns the original response with Idempotency-Replayed: true.

Request body

Unknown keys are refused with 422, naming the key.

unresolved_work_itemsstringRequired

What happens to the sprint's unresolved work items.

move_to_next_sprint: Move the unresolved items onto the sprint named by next_sprint_id, which is required for this strategy and must be a not-yet-completed sprint on the same project.
move_to_backlog: Detach the unresolved items from every sprint, so they return to the project backlog.
leave_on_sprint: Leave the unresolved items on the sprint being completed, so the closed sprint keeps them for its history.

New values may be added.

next_sprint_idinteger or null → Sprint.id

Sprint that receives the unresolved work items. Required, and only used, with move_to_next_sprint; it must be a not-yet-completed sprint on the same project.

Required when unresolved_work_items, move_to_next_sprint.

Response 200

Returns a Sprint in the detail view.

Headers

ETag: A strong validator of exactly this representation.
Idempotency-Replayed: true when this response was replayed from a stored Idempotency-Key rather than produced by a new write.
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