# Sprints

Sprints of scrum projects: the list, the current active sprint, one record by ID, and creating, updating, completing and deleting a sprint. A sprint ID is also used by operations on the columns of its board.

**Scope:** `task` | **Base URL:** `https://vibecode.bitrix24.com/v1` | **Auth:** `X-Api-Key`

## Operations

- [List sprints](./sprints/list.md) — `GET /v1/scrum/sprints`
- [Active sprint](./sprints/active.md) — `GET /v1/scrum/sprints/active?groupId=N`
- [Get a sprint](./sprints/get.md) — `GET /v1/scrum/sprints/:id`
- [Create a sprint](./sprints/create.md) — `POST /v1/scrum/sprints`
- [Update a sprint](./sprints/update.md) — `PATCH /v1/scrum/sprints/:id`
- [Delete a sprint](./sprints/delete.md) — `DELETE /v1/scrum/sprints/:id`
- [Complete the active sprint](./sprints/complete.md) — `POST /v1/scrum/groups/:groupId/sprints/active/complete`

## Statuses

The `status` field has three possible values: `planned` for a planned sprint, `active` for the current sprint, and `completed` for a completed sprint.

## Starting a sprint

`POST /v1/scrum/sprints/:id/start` starts a planned sprint. The sprint ID is passed in the path, no request body is sent.

## See also

- [Scrum kanban stages](/docs/scrum/stages)
- [Scrum epics](/docs/scrum/epics)
- [Task placement](/docs/scrum/tasks)
- [Scrum](/docs/scrum)
