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

Get a checklist item

GET /v1/tasks/:taskId/checklist/:itemId

Returns a single checklist item by ID.

Parameters

Parameter Type Required Description
ParametertaskId (path) Typeinteger Requiredyes DescriptionTask ID
ParameteritemId (path) Typeinteger Requiredyes DescriptionChecklist item ID. List of items — GET /v1/tasks/:taskId/checklist

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/tasks/3943/checklist/213" \
  -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/3943/checklist/213",
  { headers: { "X-Api-Key": "YOUR_API_KEY" } }
);
const { data } = await res.json();

JavaScript — OAuth application

javascript 
const res = await fetch(
  "https://vibecode.bitrix24.com/v1/tasks/3943/checklist/213",
  {
    headers: {
      "X-Api-Key": "YOUR_APP_KEY",
      "Authorization": "Bearer USER_SESSION_TOKEN",
    },
  }
);
const { data } = await res.json();

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe checklist item. Its fields are in the data.* rows below
Fielddata.id Typestring DescriptionItem ID
Fielddata.taskId Typestring DescriptionParent task ID
Fielddata.parentId Typeinteger / string DescriptionParent item ID. 0 — a top-level item
Fielddata.title Typestring DescriptionItem text
Fielddata.sortIndex Typestring DescriptionSort index
Fielddata.isComplete Typestring DescriptionCompletion status — "Y" / "N"
Fielddata.isImportant Typestring DescriptionImportance flag — "Y" / "N"
Fielddata.createdBy Typestring DescriptionItem author
Fielddata.toggledBy Typestring | null DescriptionWho last changed the completion status
Fielddata.toggledDate Typestring DescriptionWhen the status was last changed. An empty string if never changed
Fielddata.members Typearray DescriptionItem members — objects { id, type, name, personalPhoto, personalGender, image, isCollaber }
Fielddata.attachments Typearray | object DescriptionItem attachments. An empty array if there are none. Otherwise, an object keyed by attachment ID; each value is an object with the fields attachmentId, name, size, fileId (the Drive file ID), downloadUrl, and viewUrl

Response example

JSON 
{
  "success": true,
  "data": {
    "id": "213",
    "taskId": "3943",
    "parentId": "211",
    "createdBy": "1317",
    "title": "Collect and check documents",
    "sortIndex": "100",
    "isComplete": "N",
    "isImportant": "Y",
    "toggledBy": null,
    "toggledDate": "",
    "members": [
      {
        "id": "1317",
        "type": "A",
        "name": "Jane Doe",
        "personalPhoto": "35959",
        "personalGender": "",
        "image": "https://example.bitrix24.com/...",
        "isCollaber": false
      }
    ],
    "attachments": []
  }
}

Error response example

404 — the item does not exist or is not accessible:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Checklist item not found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptiontaskId or itemId is not a positive integer
HTTP404 CodeNOT_FOUND DescriptionThe item with the given itemId was deleted, never existed, or is not accessible to the key
HTTP404 CodeTASK_NOT_FOUND DescriptionBitrix24 reported that the parent task is missing or not accessible to the key
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the task scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

  • A missing item returns 404 NOT_FOUND. Requests for a nonexistent or deleted itemId previously returned 422 BITRIX_ERROR with the message from an internal Bitrix24 exception (ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE). The response now matches those of the other task routes.

See also