For AI agents: markdown of this page — /docs-content-en/scrum/sprints/active.md documentation index — /llms.txt

Active sprint

GET /v1/scrum/sprints/active

Returns the current active sprint of a single scrum project. If the project has no active sprint, the request still succeeds and returns data: null.

Parameters

Parameter Type Required Description
ParametergroupId (query) Typenumber Requiredyes DescriptionScrum project ID. Obtain it from GET /v1/workgroups

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/scrum/sprints/active?groupId=45" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/scrum/sprints/active?groupId=45" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/sprints/active?groupId=45', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data: sprint } = await res.json()
console.log(sprint?.name ?? 'No active sprint')

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/sprints/active?groupId=45', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data: sprint } = await res.json()
console.log(sprint?.name ?? 'No active sprint')

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject | null DescriptionActive sprint, or null when none exists
Fielddata.id Typenumber DescriptionSprint ID. The same value as sprintId in stage operations
Fielddata.groupId Typenumber DescriptionScrum project ID
Fielddata.entityType Typestring DescriptionRecord type, sprint
Fielddata.name Typestring DescriptionSprint name
Fielddata.goal Typestring DescriptionSprint goal
Fielddata.sort Typenumber DescriptionSprint order within the project
Fielddata.createdBy Typenumber DescriptionID of the sprint author
Fielddata.modifiedBy Typenumber DescriptionID of the employee who last changed the sprint
Fielddata.dateStart Typestring DescriptionSprint start in ISO 8601 format
Fielddata.dateEnd Typestring DescriptionSprint end in ISO 8601 format
Fielddata.status Typestring DescriptionAlways active for a returned record

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 11,
    "groupId": 45,
    "entityType": "sprint",
    "name": "Sprint 3",
    "goal": "",
    "sort": 0,
    "createdBy": 29,
    "modifiedBy": 29,
    "dateStart": "2023-09-15T01:00:00+00:00",
    "dateEnd": "2023-09-29T01:00:00+00:00",
    "status": "active"
  }
}

Error response example

400 — groupId is missing:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupId must be a positive integer"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptiongroupId is missing or is not a positive integer
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no tokens configured
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the task scope
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 refused to read the project's sprints

The full list of common API errors — Errors.

Known specifics

  • A scrum project can have at most one active sprint.
  • Having no active sprint is a normal project state, so the response contains data: null rather than a 404 error.

See also