Create a sprint

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

MCP id sprints.storeAlso on this path: GET List sprints

Creates an upcoming sprint on a project and returns it with a Location header: is_active is false and started_at and completed_at are null, whatever start_date and end_date say; planning dates does not start a sprint.

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. 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: A two-week sprint on a project

curl -X POST \
  'https://<your-url>/api/v2/sprints' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "project_id": 1,
    "name": "Sprint 14",
    "description": "Finish the invoicing export.",
    "start_date": "2026-03-02",
    "end_date": "2026-03-13"
  }'

const response = await fetch('https://<your-url>/api/v2/sprints', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "project_id": 1,
    "name": "Sprint 14",
    "description": "Finish the invoicing export.",
    "start_date": "2026-03-02",
    "end_date": "2026-03-13"
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('Idempotency-Key', '<key>')
    ->post('https://<your-url>/api/v2/sprints', [
        'project_id' => 1,
        'name' => 'Sprint 14',
        'description' => 'Finish the invoicing export.',
        'start_date' => '2026-03-02',
        'end_date' => '2026-03-13',
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/sprints',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'project_id': 1, 'name': 'Sprint 14', 'description': 'Finish the invoicing export.', 'start_date': '2026-03-02', 'end_date': '2026-03-13'},
)

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"
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/idempotency-key-in-flight",
  "title": "Idempotency key in flight",
  "status": 409,
  "detail": "The original request for this Idempotency-Key is still being processed. Retry shortly.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S"
}

{
  "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

Start it with POST sprints/{sprint}/actions/start. order is not accepted: the new sprint is placed last within its project and is reordered only in plnnrly. project_id is accepted here and only here: a sprint cannot be moved between projects.

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.

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.

project_idinteger → Project.idRequired

The project this sprint belongs to. A sprint cannot be moved between projects, so this is accepted on create only.

namestring≤ 255Required

Sprint name as shown in plnnrly, e.g. Sprint 14.

descriptionstring or null

Free-text sprint goal. Plain text, not markup.

start_datedate (YYYY-MM-DD) or null

Planned first day of the sprint. Independent of started_at: planning a date does not start the sprint.

end_datedate (YYYY-MM-DD) or null

Planned last day of the sprint. Independent of completed_at.

Must be on or after start_date.

Response 201

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.
Location: The absolute URL of the created or queued resource.
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