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

Task placement in scrum

Read and change a task's scrum row: backlog or sprint, epic binding, story points, sort order. A task is first created via POST /v1/tasks, then placed in scrum.

Scope: task | Base URL: https://vibecode.bitrix24.com/v1 | Auth: X-Api-Key

Get a task's scrum placement

GET /v1/scrum/tasks/:taskId

Returns the task's current scrum row. Use it before moving a task to learn its placement, or after a change to confirm it was applied.

Parameters

Parameter Type Req. Description
taskId number yes Task ID (path parameter). Source: GET /v1/tasks

Examples

curl — personal key

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

curl — OAuth app

Terminal 
curl https://vibecode.bitrix24.com/v1/scrum/tasks/59 \
  -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/tasks/59', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Placement:', data)

JavaScript — OAuth app

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

Response fields

Field Type Description
success boolean Always true on success
data.entityId number ID of the backlog or sprint the task is in
data.epicId number Epic ID. 0 — the task is not bound to an epic. Source: GET /v1/scrum/epics
data.storyPoints string Story points, for example "3". Empty string — not set
data.sort number Position in the list
data.sortFloat number Position in the list. Takes priority over sort
data.createdBy number ID of the placement author. Source: GET /v1/users
data.modifiedBy number ID of the last editor. Source: GET /v1/users

Response example

JSON 
{
  "success": true,
  "data": {
    "entityId": 1,
    "storyPoints": "3",
    "epicId": 11,
    "sort": 255,
    "sortFloat": 512,
    "createdBy": 1,
    "modifiedBy": 1
  }
}

Error response example

422 — the task is not placed in scrum or does not exist:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Task not found"
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS taskId is not a positive integer
422 BITRIX_ERROR The task was not found or is not placed in scrum
403 SCOPE_DENIED The key lacks the task scope
401 TOKEN_MISSING The key has no configured tokens

Full list of common API errors — Errors.

See also