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

Check whether a completed sprint exists

GET /v1/scrum/groups/:groupId/team-speed

Checks whether the scrum project has at least one completed sprint from which team velocity can be calculated.

Parameters

Parameter Type Required Description
ParametergroupId (path) Typenumber Requiredyes DescriptionScrum project ID. List: GET /v1/workgroups

Examples

curl — personal key

Terminal
curl "https://vibecode.bitrix24.com/v1/scrum/groups/45/team-speed" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

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

const { data } = await res.json()
console.log(data.existsCompletedSprint ? 'Completed sprints exist' : 'No completed sprints')

JavaScript — OAuth application

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

const { data } = await res.json()
console.log(data.existsCompletedSprint ? 'Completed sprints exist' : 'No completed sprints')

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.existsCompletedSprint Typeboolean Descriptiontrue — the project has at least one completed sprint, false — it has none. A non-scrum workgroup the user belongs to also returns false

Response example

JSON
{
  "success": true,
  "data": {
    "existsCompletedSprint": true
  }
}

Error response example

422 — the project does not exist or the user has no access to it:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "You do not have access.",
    "b24Code": "TASKS_SCS_02"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptiongroupId is not a positive integer
HTTP401 CodeMISSING_API_KEY DescriptionX-Api-Key is not provided
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no tokens configured
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the task scope
HTTP422 CodeBITRIX_ERROR DescriptionThe project does not exist or the user has no access to it. error.b24Code is TASKS_SCS_02

The full list of common API errors — Errors.

Known specifics

See also