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
taskId (path) integer yes Task ID
itemId (path) integer yes Checklist 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
success boolean Always true on success
data.id string Item ID
data.taskId string Parent task ID
data.parentId integer / string Parent item ID. 0 — a top-level item
data.title string Item text
data.sortIndex string Sort index
data.isComplete string Completion status — "Y" / "N"
data.isImportant string Importance flag — "Y" / "N"
data.createdBy string Item author
data.toggledBy string | null Who last changed the completion status
data.toggledDate string When the status was last changed. An empty string if never changed
data.members array Item members — objects { id, type, name, personalPhoto, personalGender, image, isCollaber }
data.attachments array Attached files

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
400 INVALID_PARAMS taskId or itemId is not a positive integer
404 NOT_FOUND The item with the given itemId was deleted, never existed, or is not accessible to the key. The same code arrives when the task taskId itself is missing
403 SCOPE_DENIED The API key lacks the task scope
401 TOKEN_MISSING The API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

  • A missing item returns 404 NOT_FOUND. A nonexistent or deleted itemId used to answer 422 BITRIX_ERROR carrying the text of an internal Bitrix24 exception (ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE) — the answer is now the same as on the neighbouring routes of the task cluster.

See also