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

Get a sprint

GET /v1/scrum/sprints/:id

Returns one sprint by its identifier regardless of its status: planned, active, or completed.

Parameters

Parameter Type Required Description
id (path) number Yes Sprint ID. Obtain it from List sprints or Active sprint

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/scrum/sprints/11" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/scrum/sprints/11" \
  -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/11', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data: sprint } = await res.json()
console.log(sprint.name, sprint.status)

JavaScript — OAuth application

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

const { data: sprint } = await res.json()
console.log(sprint.name, sprint.status)

Response fields

Field Type Description
success boolean Always true on success
data object Sprint
data.id number Sprint ID
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 planned, active, or completed

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

404 — sprint not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Sprint not found"
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS id is not a positive integer
401 TOKEN_MISSING The key has no tokens configured
403 SCOPE_DENIED The key lacks the task scope
404 ENTITY_NOT_FOUND Sprint not found
422 BITRIX_ERROR Bitrix24 refused to read the sprint, for example because the key's user cannot access the project

The full list of common API errors — Errors.

See also