Для 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 Типobject ОписаниеПункт чек-листа. Его поля — в строках data.* ниже
Поле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 | object ОписаниеВложения пункта. Без вложений — пустой массив. С вложениями — объект, где ключ — ID вложения, а значение — объект с полями attachmentId, name, size, downloadUrl, viewUrl и fileId — ID файла Диска

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

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": []
  }
}

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

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

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеtaskId или itemId не положительное целое
HTTP404 КодNOT_FOUND ОписаниеПункт с указанным itemId удалён, никогда не существовал либо недоступен ключу
HTTP404 КодTASK_NOT_FOUND ОписаниеБитрикс24 сообщил, что родительская задача отсутствует или недоступна ключу
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа task
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов

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

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

  • Отсутствующий пункт возвращает 404 NOT_FOUND. Раньше на несуществующий или удалённый itemId приходил 422 BITRIX_ERROR с текстом внутреннего исключения Битрикс24 (ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE) — теперь ответ такой же, как у соседних маршрутов кластера задач.

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