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

Список пунктов чек-листа

GET /v1/tasks/:taskId/checklist

Возвращает все пункты чек-листа задачи, включая вложенные (дочерние) пункты.

Параметры

Параметр Тип Обяз. Описание
ПараметрtaskId (path) Типinteger Обяз.да ОписаниеID задачи. Список: GET /v1/tasks
Параметрsort (query) Типstring Обяз.нет ОписаниеСортировка в формате поле:направление, например sortIndex:asc. Поля: id, parentId, createdBy, title, sortIndex, isComplete, isImportant, toggledBy, toggledDate. Направление — asc / desc (по умолчанию asc). Без параметра пункты идут по sortIndex по возрастанию, как при sortIndex:asc
Параметрstart (query) Типinteger Обяз.нет ОписаниеПринимается, но выборку не сдвигает: при любом значении метод возвращает все пункты чек-листа. Значение — целое неотрицательное число, иначе 400 INVALID_PARAMS

Пагинация. Постраничной выдачи нет: все пункты чек-листа приходят одним ответом, meta.total равно числу элементов data.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/tasks/3943/checklist?sort=sortIndex:asc" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/tasks/3943/checklist?sort=sortIndex:asc" \
  -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?sort=sortIndex:asc",
  { 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?sort=sortIndex:asc",
  {
    headers: {
      "X-Api-Key": "YOUR_APP_KEY",
      "Authorization": "Bearer USER_SESSION_TOKEN",
    },
  }
);
const { data } = await res.json();

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеМассив пунктов чек-листа
Поле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 ОписаниеID автора пункта. Список сотрудников: GET /v1/users
Полеdata[].toggledBy Типstring | null ОписаниеID сотрудника, который последним менял статус выполнения. Список сотрудников: GET /v1/users
Полеdata[].toggledDate Типstring ОписаниеКогда статус менялся последний раз. Пустая строка, если не менялся
Полеdata[].members Типarray ОписаниеУчастники пункта — объекты { id, type, name, personalPhoto, personalGender, image, isCollaber }. id — ID сотрудника из GET /v1/users
Полеdata[].attachments Типarray | object ОписаниеВложения пункта. Без вложений — пустой массив. С вложениями — объект, где ключ — ID вложения, а значение — объект с полями attachmentId, name, size, downloadUrl, viewUrl и fileId — ID файла Диска
Полеmeta.total Типnumber ОписаниеОбщее число пунктов в выборке

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": "211",
      "taskId": "3943",
      "parentId": 0,
      "createdBy": "1317",
      "title": "Документы",
      "sortIndex": "1",
      "isComplete": "N",
      "isImportant": "N",
      "toggledBy": null,
      "toggledDate": "",
      "members": [],
      "attachments": []
    },
    {
      "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": []
    }
  ],
  "meta": { "total": 2 }
}

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

404 — Битрикс24 сообщил, что задача не найдена или недоступна:

JSON 
{
  "success": false,
  "error": {
    "code": "TASK_NOT_FOUND",
    "message": "Task not found or not accessible."
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеtaskId не положительное целое, неизвестное поле сортировки или start не целое неотрицательное число
HTTP404 КодTASK_NOT_FOUND ОписаниеБитрикс24 сообщил TASK_NOT_FOUND_OR_NOT_ACCESSIBLE: задача отсутствует или недоступна ключу
HTTP422 КодBITRIX_ERROR ОписаниеДругой отказ Битрикс24 без более точного кода ошибки
HTTP429 КодRATE_LIMITED ОписаниеБитрикс24 ограничил частоту запросов. Учитывайте заголовок Retry-After
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа task
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP400 КодUNSUPPORTED_FILTER ОписаниеПередан параметр filter, которого у этой ручки нет. В тексте ошибки названо, чем пользоваться вместо него

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

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

  • Существующая задача без пунктов отвечает 200 с пустым массивом.

  • parentId: 0 — пункт верхнего уровня, сам являющийся чек-листом. Дочерние пункты ссылаются на его id через свой parentId.

  • Числовые значения и флаги — строки. id, taskId, sortIndex приходят строками. isComplete / isImportant — строками "Y"/"N", не булевыми значениями.

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