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 a single sprint by its identifier, regardless of its status: planned, active, or completed.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionSprint 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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionSprint
Fielddata.id Typenumber DescriptionSprint ID
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 Descriptionplanned, 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
HTTP400 CodeINVALID_PARAMS Descriptionid is not a positive integer
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no tokens configured
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the task scope
HTTP404 CodeENTITY_NOT_FOUND DescriptionSprint not found
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 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