Получить список пунктов чек-листа task.checklistitem.getlist
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
taskКто может выполнять метод: любой пользователь с правом доступа на чтение задачи или выше
Метод task.checklistitem.getlist получает список пунктов чек-листов в задаче.
Пункты всех чек-листов и уровней вложенности приходят одним плоским списком, без постраничной навигации: параметр start не учитывается, полей next и total в ответе нет. Чтобы восстановить дерево, группируйте пункты по PARENT_ID, приведя значение к числу.
Параметры метода
Передавайте параметры в запросе в соответствии с порядком в таблице. Если нарушить порядок, запрос вернет ошибку.
Обязательные параметры отмечены *
|
Название |
Описание |
|
TASKID* |
Идентификатор задачи. Идентификатор можно получить при создании задачи или методом получения списка задач |
|
ORDER |
Объект для сортировки результата вида Сортировать можно по полям:
Направление сортировки может принимать значения:
Значение в смешанном регистре, например Сортировка применяется ко всему списку, а не внутри каждого подсписка. По умолчанию результат сортируется по |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"ORDER":{"IS_COMPLETE":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.checklistitem.getlist
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"ORDER":{"IS_COMPLETE":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.checklistitem.getlist
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ChecklistItem = {
ID: string
TASK_ID: string
PARENT_ID: string | number
CREATED_BY: string
TITLE: string
SORT_INDEX: string
IS_COMPLETE: 'Y' | 'N'
IS_IMPORTANT: 'Y' | 'N'
TOGGLED_BY: string | null
TOGGLED_DATE: ISODate | ''
MEMBERS: Array<{
ID: string
TYPE: string
NAME: string
PERSONAL_PHOTO: string
PERSONAL_GENDER: string
IMAGE: string
IS_COLLABER: boolean
}>
ATTACHMENTS: Record<string, {
ATTACHMENT_ID: number
NAME: string
SIZE: string
FILE_ID: string
DOWNLOAD_URL: string
VIEW_URL: string
}> | []
}
try {
// task.checklistitem.getlist returns all checklist items of the task in one response,
// without pagination, so a plain call.make is enough and `start` is not needed.
const response = await $b24.actions.v2.call.make<ChecklistItem[]>({
method: 'task.checklistitem.getlist',
params: {
TASKID: 8017,
ORDER: {
IS_COMPLETE: 'ASC',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Checklist items count:', result.length, 'First item:', result[0]?.ID, result[0]?.TITLE)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getChecklistItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// task.checklistitem.getlist returns all checklist items of the task in one response,
// without pagination, so a plain call.make is enough and `start` is not needed.
const response = await $b24.actions.v2.call.make({
method: 'task.checklistitem.getlist',
params: {
TASKID: 8017,
ORDER: {
IS_COMPLETE: 'ASC',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Checklist items count:', result.length, 'First item:', result[0]?.ID, result[0]?.TITLE)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getChecklistItems)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
order = {
"IS_COMPLETE": "ASC",
}
try:
bitrix_response = client.task.checklistitem.getlist(
task_id=8017,
order=order,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'task.checklistitem.getlist',
[
'TASKID' => 8017,
'ORDER' => [
'IS_COMPLETE' => 'ASC'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching checklist items: ' . $e->getMessage();
}
BX24.callMethod(
'task.checklistitem.getlist',
{
'TASKID': 8017,
'ORDER': {
'IS_COMPLETE': 'ASC'
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'task.checklistitem.getlist',
[
'TASKID' => 8017,
'ORDER' => [
'IS_COMPLETE' => 'ASC'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "task.checklistitem.getlist", b24.Params{
"TASKID": 8017,
"ORDER": b24.Params{
"IS_COMPLETE": "ASC",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("task.checklistitem.getlist: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
TaskID b24.ID `json:"TASK_ID"`
ParentID b24.ID `json:"PARENT_ID"`
CreatedBy string `json:"CREATED_BY"`
Title string `json:"TITLE"`
SortIndex string `json:"SORT_INDEX"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.TaskID)
}
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "477",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Подготовить договор Светлана Иванова",
"SORT_INDEX": "2",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": "503",
"TOGGLED_DATE": "2025-11-10T15:02:30+03:00",
"MEMBERS": [
{
"ID": "103",
"TYPE": "A",
"NAME": "Светлана Иванова",
"PERSONAL_PHOTO": "8644",
"PERSONAL_GENDER": "F",
"IMAGE": "https://mysite.ru/b17053/resize_cache/8644/c0120a8d7c10d63c83e32398d1ec4d9e/main/45f/45fff10d17d398a5583184c8350cd197/buh.jpg",
"IS_COLLABER": false
}
],
"ATTACHMENTS": {
"1113": {
"ATTACHMENT_ID": 1113,
"NAME": "Инструкция.docx",
"SIZE": "115161",
"FILE_ID": "5065",
"DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=1113&action=download&ncc=1",
"VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=1113&action=show&ncc=1"
},
"1115": {
"ATTACHMENT_ID": 1115,
"NAME": "Список документов.xlsx",
"SIZE": "14675",
"FILE_ID": "5067",
"DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=1115&action=download&ncc=1",
"VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=1115&action=show&ncc=1"
}
}
},
{
"ID": "431",
"TASK_ID": "8017",
"PARENT_ID": 0,
"CREATED_BY": "503",
"TITLE": "Чек-лист 1",
"SORT_INDEX": "0",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "447",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Согласовать с клиентом детали",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "469",
"TASK_ID": "8017",
"PARENT_ID": "447",
"CREATED_BY": "503",
"TITLE": "Согласовать с руководителем Андрей Карпов Андрей Сергеев",
"SORT_INDEX": "2",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [
{
"ID": "3",
"TYPE": "A",
"NAME": "Андрей Карпов",
"PERSONAL_PHOTO": "249",
"PERSONAL_GENDER": "M",
"IMAGE": "https://mysite.ru/b17053/resize_cache/249/c0120a8d7c10d63c83e32398d1ec4d9e/main/cd526b0644e7ff4d794ea41cb36bc423/odmin.png",
"IS_COLLABER": false
},
{
"ID": "11",
"TYPE": "U",
"NAME": "Андрей Сергеев",
"PERSONAL_PHOTO": "231",
"PERSONAL_GENDER": "",
"IMAGE": "https://mysite.ru/b17053/resize_cache/231/c0120a8d7c10d63c83e32398d1ec4d9e/main/026bf59e161a0bd50f401d3796800651/66b.jpg",
"IS_COLLABER": false
}
],
"ATTACHMENTS": []
},
{
"ID": "471",
"TASK_ID": "8017",
"PARENT_ID": "447",
"CREATED_BY": "503",
"TITLE": "Подготовить решение",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "491",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Подписать договор",
"SORT_INDEX": "3",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "433",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Найти все документы по клиенту",
"SORT_INDEX": "0",
"IS_COMPLETE": "Y",
"IS_IMPORTANT": "N",
"TOGGLED_BY": "503",
"TOGGLED_DATE": "2025-11-10T15:02:30+03:00",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "485",
"TASK_ID": "8017",
"PARENT_ID": "447",
"CREATED_BY": "503",
"TITLE": "Договориться о встрече Андрей Сергеев",
"SORT_INDEX": "0",
"IS_COMPLETE": "Y",
"IS_IMPORTANT": "N",
"TOGGLED_BY": "503",
"TOGGLED_DATE": "2025-11-10T15:02:33+03:00",
"MEMBERS": [
{
"ID": "11",
"TYPE": "U",
"NAME": "Андрей Сергеев",
"PERSONAL_PHOTO": "231",
"PERSONAL_GENDER": "",
"IMAGE": "https://mysite.ru/b17053/resize_cache/231/c0120a8d7c10d63c83e32398d1ec4d9e/main/026bf59e161a0bd50f401d3796800651/66b.jpg",
"IS_COLLABER": false
}
],
"ATTACHMENTS": []
}
],
"time": {
"start": 1762780903,
"finish": 1762780903.978847,
"duration": 0.9788470268249512,
"processing": 0,
"date_start": "2025-11-10T16:21:43+03:00",
"date_finish": "2025-11-10T16:21:43+03:00",
"operating_reset_at": 1762781503,
"operating": 0.3446669578552246
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список объектов с описанием полей пунктов чек-листа |
|
time |
Информация о времени выполнения запроса |
Поля объекта result
|
Название |
Описание |
|
ID |
Идентификатор пункта чек-листа |
|
TASK_ID |
Идентификатор задачи, к которой относится пункт |
|
PARENT_ID |
Идентификатор родительского пункта. У корневого пункта возвращается число |
|
CREATED_BY |
Идентификатор автора пункта |
|
TITLE |
Текст пункта чек-листа. Если |
|
SORT_INDEX |
Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке |
|
IS_COMPLETE |
Статус выполнения пункта. Возможные значения:
|
|
IS_IMPORTANT |
Отметка важности пункта. Возможные значения:
|
|
TOGGLED_BY |
Идентификатор пользователя, который последний раз сменил статус пункта. Значение |
|
TOGGLED_DATE |
Дата и время изменения статуса пункта в формате Пустая строка, если статус пункта не меняли, в том числе у пункта, созданного сразу выполненным |
|
MEMBERS |
Список объектов с описанием участников |
|
ATTACHMENTS |
Объект с описанием прикрепленных файлов. Ключ — идентификатор прикрепления файла |
Объект members
|
Название |
Описание |
|
ID |
Идентификатор пользователя |
|
TYPE |
Роль пользователя в пункте чек-листа. Возможные значения:
|
|
NAME |
Имя пользователя |
|
PERSONAL_PHOTO |
Идентификатор файла аватара пользователя |
|
PERSONAL_GENDER |
Пол пользователя. Возможные значения:
Пустая строка, если пол не указан в профиле |
|
IMAGE |
Ссылка на аватар пользователя |
|
IS_COLLABER |
Признак, что пользователь является внешним участником |
Объект attachments
|
Название |
Описание |
|
ATTACHMENT_ID |
Идентификатор прикрепления |
|
NAME |
Имя файла |
|
SIZE |
Размер файла в байтах |
|
FILE_ID |
Идентификатор файла на Диске |
|
DOWNLOAD_URL |
Ссылка для скачивания файла |
|
VIEW_URL |
Ссылка для просмотра файла в браузере |
Обработка ошибок
HTTP-статус: 400
{
"error":"ERROR_CORE",
"error_description":"TASKS_ERROR_EXCEPTION_#8; Action failed; 8/TE/ACTION_FAILED_TO_BE_PROCESSED<br>"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
TASKS_ERROR_EXCEPTION_#8; Action failed; 8/TE/ACTION_FAILED_TO_BE_PROCESSED |
Возможные причины:
|
|
|
TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) expected by method ctaskchecklistitem::getlist(), but not given.; 256/TE/WRONG_ARGUMENTS |
Не передан обязательный параметр |
|
|
TASKS_ERROR_ASSERT_EXCEPTION |
Значение |
|
|
TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskchecklistitem::getlist() expected to be of type "integer", but given something else.; 256/TE/WRONG_ARGUMENTS |
Указано значение неверного типа для |
|
|
TASKS_ERROR_EXCEPTION_#256; Param #1 (arOrder) for method ctaskchecklistitem::getlist() must not contain key "IS_COMPLETED".; 256/TE/WRONG_ARGUMENTS |
В |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Чек-листы: обзор методов
- Добавить пункт чек-листа task.checklistitem.add
- Изменить пункт чек-листа task.checklistitem.update
- Получить пункт чек-листа task.checklistitem.get
- Удалить пункт чек-листа task.checklistitem.delete
- Перенести пункт чек-листа task.checklistitem.moveafteritem
- Пометить пункт чек-листа как выполненный task.checklistitem.complete
- Пометить пункт чек-листа как невыполненный task.checklistitem.renew
- Проверить разрешение действия task.checklistitem.isactionallowed