[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-scrum\u002Fmetrics\u002Fburn-down":3,"docs-tabs-scrum\u002Fmetrics\u002Fburn-down":6},{"content":4,"lastmod":5},"## Get burndown chart data\n\n`GET \u002Fv1\u002Fscrum\u002Fgroups\u002F:groupId\u002Fburn-down`\n\nReturns the scrum project sprint used to build the burndown chart: the current active sprint, or the last completed one if there is no active sprint.\n\n## Parameters\n\n| Parameter | Type | Required | Description |\n|----------|-----|-------|----------|\n| `groupId` (path) | number | yes | Scrum project ID. List: [`GET \u002Fv1\u002Fworkgroups`](\u002Fdocs\u002Fentities\u002Fworkgroups\u002Flist) |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fgroups\u002F45\u002Fburn-down\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n```\n\n### curl — OAuth application\n\n```bash\ncurl \"https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fgroups\u002F45\u002Fburn-down\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\"\n```\n\n### JavaScript — personal key\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fgroups\u002F45\u002Fburn-down', {\n  headers: { 'X-Api-Key': 'YOUR_API_KEY' },\n})\n\nconst { data } = await res.json()\nconsole.log(data.sprint ? `${data.sprint.name}: ${data.sprint.status}` : 'No sprints')\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fscrum\u002Fgroups\u002F45\u002Fburn-down', {\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n  },\n})\n\nconst { data } = await res.json()\nconsole.log(data.sprint ? `${data.sprint.name}: ${data.sprint.status}` : 'No sprints')\n```\n\n## Response fields\n\n| Field | Type | Description |\n|------|-----|----------|\n| `success` | boolean | Always `true` on success |\n| `data.sprint` | object \\| null | The sprint for the chart, or `null` if the project has neither an active nor a completed sprint. A non-scrum workgroup the user belongs to also returns `null` |\n| `data.sprint.id` | number | Sprint ID. Full data: [`GET \u002Fv1\u002Fscrum\u002Fsprints\u002F:id`](\u002Fdocs\u002Fscrum\u002Fsprints\u002Fget) |\n| `data.sprint.groupId` | number | Scrum project ID |\n| `data.sprint.entityType` | string | Record type, `sprint` |\n| `data.sprint.name` | string | Sprint name |\n| `data.sprint.sort` | number | Sprint order within the project |\n| `data.sprint.createdBy` | number | ID of the sprint author. List: [`GET \u002Fv1\u002Fusers`](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `data.sprint.modifiedBy` | number | ID of the employee who last modified the sprint. List: [`GET \u002Fv1\u002Fusers`](\u002Fdocs\u002Fentities\u002Fusers\u002Flist) |\n| `data.sprint.dateStart` | string | Sprint start in ISO 8601 format |\n| `data.sprint.dateEnd` | string | Sprint end in ISO 8601 format |\n| `data.sprint.status` | string | `active` — the sprint is in progress, `completed` — finished |\n| `data.sprint.info` | object | An empty object in the sprints checked |\n| `data.sprint.children` | array | An empty array in the sprints checked |\n| `data.sprint.tmpId` | string | An empty string in the sprints checked |\n\n## Response example\n\nActive sprint:\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"sprint\": {\n      \"id\": 11,\n      \"groupId\": 45,\n      \"entityType\": \"sprint\",\n      \"name\": \"Sprint 3\",\n      \"sort\": 0,\n      \"createdBy\": 29,\n      \"modifiedBy\": 29,\n      \"dateStart\": \"2023-09-15T01:00:00+00:00\",\n      \"dateEnd\": \"2023-09-29T01:00:00+00:00\",\n      \"status\": \"active\",\n      \"info\": {},\n      \"children\": [],\n      \"tmpId\": \"\"\n    }\n  }\n}\n```\n\nProject without sprints:\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"sprint\": null\n  }\n}\n```\n\n## Error response example\n\n422 — the project does not exist or the user has no access to it:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"BITRIX_ERROR\",\n    \"message\": \"You do not have access.\",\n    \"b24Code\": \"TASKS_SCS_02\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Description |\n|------|-----|----------|\n| 400 | `INVALID_PARAMS` | `groupId` is not a positive integer |\n| 401 | `MISSING_API_KEY` | `X-Api-Key` is not provided |\n| 401 | `TOKEN_MISSING` | The key has no tokens configured |\n| 403 | `SCOPE_DENIED` | The key lacks the `task` scope |\n| 422 | `BITRIX_ERROR` | The project does not exist or the user has no access to it. `error.b24Code` is `TASKS_SCS_02` |\n\nFor the full list of common API errors, see [Errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\n- Chart points are built from the sprint tasks and their story points: [`GET \u002Fv1\u002Ftasks?filter[groupId]=45`](\u002Fdocs\u002Fentities\u002Ftasks\u002Flist) returns the project tasks, and [`GET \u002Fv1\u002Fscrum\u002Ftasks\u002F:taskId`](\u002Fdocs\u002Fscrum\u002Ftasks\u002Fget) returns a task's sprint and story points.\n\n## See also\n\n- [Check whether a completed sprint exists](\u002Fdocs\u002Fscrum\u002Fmetrics\u002Fteam-speed)\n- [Active sprint](\u002Fdocs\u002Fscrum\u002Fsprints\u002Factive)\n- [List sprints](\u002Fdocs\u002Fscrum\u002Fsprints\u002Flist)\n- [Sprint metrics](\u002Fdocs\u002Fscrum\u002Fmetrics)\n",null,{},1795000571359]