Для AI-агентов: markdown этой страницы — /docs-content/entities/tasks/checklist/get.md индекс документации — /llms.txt

Получить пункт чек-листа

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

Возвращает один пункт чек-листа по ID.

Параметры

Параметр Тип Обяз. Описание
taskId (path) integer да ID задачи
itemId (path) integer да ID пункта чек-листа. Список пунктов — GET /v1/tasks/:taskId/checklist

Примеры

curl — личный ключ

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

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/tasks/3943/checklist/213" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

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

JavaScript — OAuth-приложение

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id string ID пункта
data.taskId string ID родительской задачи
data.parentId integer / string ID родительского пункта. 0 — пункт верхнего уровня
data.title string Текст пункта
data.sortIndex string Индекс сортировки
data.isComplete string Статус выполнения — "Y" / "N"
data.isImportant string Признак важности — "Y" / "N"
data.createdBy string Автор пункта
data.toggledBy string | null Кто последним менял статус выполнения
data.toggledDate string Когда статус менялся последний раз. Пустая строка, если не менялся
data.members array Участники пункта — объекты { id, type, name, personalPhoto, personalGender, image, isCollaber }
data.attachments array Прикреплённые файлы

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": "213",
    "taskId": "3943",
    "parentId": "211",
    "createdBy": "1317",
    "title": "Собрать и проверить документы",
    "sortIndex": "100",
    "isComplete": "N",
    "isImportant": "Y",
    "toggledBy": null,
    "toggledDate": "",
    "members": [
      {
        "id": "1317",
        "type": "A",
        "name": "Иван Петров",
        "personalPhoto": "35959",
        "personalGender": "",
        "image": "https://example.bitrix24.ru/...",
        "isCollaber": false
      }
    ],
    "attachments": []
  }
}

Пример ответа при ошибке

422 — пункт не найден или недоступен:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "TASKS_ERROR_EXCEPTION_#512; Check listitem not found or not accessible; 512/TE/ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE",
    "b24Code": "ERROR_CORE"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS taskId или itemId не положительное целое
422 BITRIX_ERROR Пункт с указанным itemId удалён, никогда не существовал либо недоступен ключу — Битрикс24 бросил исключение. Тот же код приходит, когда нет самой задачи taskId
404 NOT_FOUND Битрикс24 вернул пустой результат без исключения — запасная ветка обработчика
403 SCOPE_DENIED API-ключ не имеет скоупа task
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Отсутствующий пункт возвращает 422, а не 404. Битрикс24 бросает исключение на несуществующий или удалённый itemId — в ответе нет чистого кода NOT_FOUND, ориентируйтесь на текст ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE. Если Битрикс24 вернёт пустой результат без исключения — придёт 404 NOT_FOUND.

Смотрите также