#Get task

GET /v1/tasks/:id

Returns a single task with all fields. In addition to the list fields, embedded objects for the creator and responsible person, the checklist, the allowed actions, and extended information about collaborators and watchers are returned.

#Parameters

Parameter Type Req. Description
id (path) number yes Task ID

#Examples

#curl — personal key

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

#curl — OAuth application

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

const { success, data } = await res.json()
console.log(data.title, '— status:', data.status)

#JavaScript — OAuth application

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

const { success, data } = await res.json()

#Response fields

Field Type Description
success boolean Always true on success
data object The task object. Base fields — see Task fields. Additional blocks are described below

Additional blocks of the single response:

Field Type Description
data.creator object Creator: { id, name, link, icon, workPosition }
data.responsible object Responsible person: same format as creator
data.accomplicesData object[] Details about collaborators (same format as creator)
data.auditorsData object[] Details about watchers (same format as creator)
data.action object Map of allowed actions (boolean): complete, start, pause, delegate, remove, edit, defer, changeDeadline, checklistAddItems, and others
data.checklist array Checklist items (an empty array if the checklist is not filled)
data.checkListTree object Checklist tree with metadata
data.newCommentsCount number Number of unread comments

#Response example

JSON
{
  "success": true,
  "data": {
    "id": "289",
    "title": "Prepare the quarterly report",
    "description": "",
    "status": "2",
    "priority": "1",
    "groupId": "0",
    "responsibleId": "79",
    "createdBy": "99",
    "createdDate": "2026-05-12T09:11:18+03:00",
    "changedDate": "2026-05-12T09:11:18+03:00",
    "deadline": "2026-05-19T18:00:00+03:00",
    "accomplices": [],
    "auditors": [],
    "checklist": [],
    "creator": {
      "id": "99",
      "name": "Anna Sokolova",
      "link": "/company/personal/user/99/",
      "icon": "https://example.bitrix24.com/.../avatar.png",
      "workPosition": null
    },
    "responsible": {
      "id": "79",
      "name": "Dmitry Orlov",
      "link": "/company/personal/user/79/",
      "icon": "/bitrix/images/tasks/default_avatar.png",
      "workPosition": null
    },
    "newCommentsCount": 0,
    "action": {
      "complete": true,
      "start": true,
      "delegate": true,
      "edit": true,
      "remove": true,
      "defer": true,
      "changeDeadline": true
    }
  }
}

#Error response example

404 — task not found:

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

#Errors

HTTP Code Description
404 ENTITY_NOT_FOUND A task with this ID was not found
403 SCOPE_DENIED The API key does not have the tasks scope
401 TOKEN_MISSING The API key has no configured tokens
401 MISSING_API_KEY The X-Api-Key header was not passed

The full list of common API errors — Errors.

#Known specifics

Embedded user data. The creator and responsible fields come as a nested object with the name, profile link, and avatar. A separate GET /v1/users/:id to display the task's author is not required.

Numeric values as strings. Most numeric fields (id, status, priority, responsibleId, createdBy, groupId, and similar) come as strings. For arithmetic and comparisons, convert via Number(value). Exceptions: newCommentsCount comes as a number (in both the list and the card); commentsCount/serviceCommentsCount come either as null or as a string ("0"/"N") — never as a number. chatId is inconsistent: a string in the list ("255"), a number in the card (255) — convert via Number().

#See also