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 one scrum project. If the project has no active sprint, the request remains successful and returns data: null.

Parameters

Parameter	Type	Required	Description
`groupId` (query)	number	Yes	Scrum 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
`success`	boolean	Always `true` on success
`data`	object \| null	Active sprint, or `null` when none exists
`data.id`	number	Sprint ID. The same value as `sprintId` in stage operations
`data.groupId`	number	Scrum project ID
`data.entityType`	string	Record type, `sprint`
`data.name`	string	Sprint name
`data.goal`	string	Sprint goal
`data.sort`	number	Sprint order within the project
`data.createdBy`	number	ID of the sprint author
`data.modifiedBy`	number	ID of the employee who last changed the sprint
`data.dateStart`	string	Sprint start in ISO 8601 format
`data.dateEnd`	string	Sprint end in ISO 8601 format
`data.status`	string	Always `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: