Sprints API

All endpoints require authentication and sprints tool permissions.

List Sprints

GET /api/sprints

Query parameters:

Param	Type	Description
project_id	string	Filter by project ID
status	string	Filter by sprint status

Response: { sprints }

Each sprint includes computed task_count and done_count fields. Results are ordered by position, then start_date, then created_at.

Get Sprint Detail

GET /api/sprints/:id

Returns { sprint, tasks, backlog } where:

• sprint is the full sprint record
• tasks are top-level tasks assigned to this sprint (excludes subtasks), each with assignee_name, assignee_picture, status_label, status_color, status_value, priority_label, priority_color
• backlog contains up to 50 unassigned top-level tasks from the same project (where sprint_id IS NULL), each with assignee_name, status_label, status_color, status_value

Errors:

Status	Body
404	{ error: "Not found" }

Create Sprint

POST /api/sprints

Requires update permission.

Body:

{
  "project_id": "string (required)",
  "name": "string (required)",
  "goal": "string (optional)",
  "start_date": "string (optional, ISO date)",
  "end_date": "string (optional, ISO date)",
  "position": "number (optional, default: 0)"
}

Response: { sprint } with status 201.

Errors:

Status	Body
400	{ error: "project_id and name required" }

Update Sprint

PUT /api/sprints/:id

Requires update permission.

Body: Any combination of the following fields:

Field	Type	Description
name	string	Sprint name
goal	string	Sprint goal
status	string	Sprint status
start_date	string	Start date (ISO)
end_date	string	End date (ISO)
position	number	Display order

Sets updated_at automatically on every update.

Response: { sprint }

Errors:

Status	Body
400	{ error: "No fields" }
404	{ error: "Not found" }

Delete Sprint

DELETE /api/sprints/:id

Requires manage permission.

Unassigns all tasks from the sprint (sets sprint_id = NULL) before deleting the sprint record.

Response: { ok: true }

Assign Task to Sprint

POST /api/sprints/:id/tasks/:taskId

Requires update permission.

Sets the task’s sprint_id to the given sprint.

Response: { ok: true }

Remove Task from Sprint

DELETE /api/sprints/:id/tasks/:taskId

Requires update permission.

Clears the task’s sprint_id (sets to NULL), moving it back to the project backlog.

Response: { ok: true }