Получить список пунктов чек-листа шаблона задачи tasks.template.checklist.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
taskКто может выполнять метод: пользователь с правом чтения шаблона задачи
Метод tasks.template.checklist.list возвращает список пунктов чек-листа шаблона задачи.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
templateId* |
Идентификатор шаблона задачи. Идентификатор шаблона задачи можно получить при создании нового шаблона |
|
filter |
Фильтр выборки пунктов чек-листа вида Фильтровать можно по полям:
Параметр |
|
select |
Список полей для выборки. В выборке можно указать поля:
|
|
order |
Объект для сортировки результата вида Сортировать можно по полям:
Направление сортировки может принимать значения:
По умолчанию результат сортируется по |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"templateId": 139,
"filter": {
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N"
},
"select": [
"ID",
"TEMPLATE_ID",
"PARENT_ID",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT"
],
"order": {
"SORT_INDEX": "asc",
"ID": "desc"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.checklist.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"templateId": 139,
"filter": {
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N"
},
"select": [
"ID",
"TEMPLATE_ID",
"PARENT_ID",
"TITLE",
"SORT_INDEX",
"IS_COMPLETE",
"IS_IMPORTANT"
],
"order": {
"SORT_INDEX": "asc",
"ID": "desc"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/tasks.template.checklist.list
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CheckListItem = {
id: string
templateId: string
parentId: number | string
title: string
sortIndex: string
isComplete: string
isImportant: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type CheckListItemsResult = {
checkListItems: Record<string, CheckListItem>
}
try {
// tasks.template.checklist.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<CheckListItemsResult>({
method: 'tasks.template.checklist.list',
params: {
templateId: 139,
filter: {
IS_COMPLETE: 'N',
IS_IMPORTANT: 'N',
},
select: [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT',
],
order: {
SORT_INDEX: 'asc',
ID: 'desc',
},
start: 0,
},
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:', Object.keys(result.checkListItems).length,
'Items:', result.checkListItems
)
}
} 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 listTemplateChecklistItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// tasks.template.checklist.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'tasks.template.checklist.list',
params: {
templateId: 139,
filter: {
IS_COMPLETE: 'N',
IS_IMPORTANT: 'N',
},
select: [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT',
],
order: {
SORT_INDEX: 'asc',
ID: 'desc',
},
start: 0,
},
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:', Object.keys(result.checkListItems).length,
'Items:', result.checkListItems
)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listTemplateChecklistItems)
</script>
try {
$response = $b24Service
->core
->call(
'tasks.template.checklist.list',
[
'templateId' => 139,
'filter' => [
'IS_COMPLETE' => 'N',
'IS_IMPORTANT' => 'N',
],
'select' => [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT',
],
'order' => [
'SORT_INDEX' => 'asc',
'ID' => 'desc',
]
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'tasks.template.checklist.list',
{
templateId: 139,
filter: {
IS_COMPLETE: 'N',
IS_IMPORTANT: 'N'
},
select: [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT'
],
order: {
SORT_INDEX: 'asc',
ID: 'desc'
}
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.template.checklist.list',
[
'templateId' => 139,
'filter' => [
'IS_COMPLETE' => 'N',
'IS_IMPORTANT' => 'N',
],
'select' => [
'ID',
'TEMPLATE_ID',
'PARENT_ID',
'TITLE',
'SORT_INDEX',
'IS_COMPLETE',
'IS_IMPORTANT',
],
'order' => [
'SORT_INDEX' => 'asc',
'ID' => 'desc',
]
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.template.checklist.list", b24.Params{
"templateId": 139,
"filter": b24.Params{
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
},
"select": []string{"ID", "TEMPLATE_ID", "PARENT_ID", "TITLE", "SORT_INDEX", "IS_COMPLETE", "IS_IMPORTANT"},
"order": b24.Params{
"SORT_INDEX": "asc",
"ID": "desc",
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("tasks.template.checklist.list: %w", err)
}
// Метод заворачивает ответ в объект с ключом "checkListItems".
raw, ok := b24.Unwrap(res.Result, "checkListItems")
if !ok {
return fmt.Errorf("в ответе нет ключа checkListItems")
}
fmt.Printf("%s\n", raw)
Обработка ответа
HTTP-статус: 200
{
"result": {
"checkListItems": {
"23": {
"id": "23",
"templateId": "139",
"parentId": 0,
"title": "Что нужно сделать",
"sortIndex": "0",
"isComplete": "N",
"isImportant": "N"
},
"27": {
"id": "27",
"templateId": "139",
"parentId": "23",
"title": "2. Заполнить форму отчета",
"sortIndex": "1",
"isComplete": "N",
"isImportant": "N"
},
"29": {
"id": "29",
"templateId": "139",
"parentId": "23",
"title": "3. Отправить отчет руководителю",
"sortIndex": "3",
"isComplete": "N",
"isImportant": "N"
},
"25": {
"id": "25",
"templateId": "139",
"parentId": "23",
"title": "1. Собрать данные",
"sortIndex": "4",
"isComplete": "N",
"isImportant": "N"
}
}
},
"time": {
"start": 1773316805,
"finish": 1773316806.016895,
"duration": 1.016895055770874,
"processing": 0,
"date_start": "2026-03-12T15:00:05+03:00",
"date_finish": "2026-03-12T15:00:06+03:00",
"operating_reset_at": 1773317406,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
checkListItems |
Объект, в котором ключ — идентификатор пункта чек-листа, а значение — описание пункта чек-листа (подробное описание). Набор полей в ответе зависит от параметра |
Объект checkListItem
|
Название |
Описание |
|
id |
Идентификатор пункта чек-листа |
|
copiedId |
Идентификатор исходного пункта при копировании, если есть |
|
userId |
Идентификатор пользователя, в контексте которого сформирован объект |
|
createdBy |
Идентификатор автора пункта |
|
parentId |
Идентификатор родительского пункта. Значение |
|
title |
Текст пункта чек-листа |
|
sortIndex |
Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке |
|
displaySortIndex |
Вспомогательное значение порядка отображения |
|
isComplete |
Статус выполнения пункта |
|
isImportant |
Отметка важности пункта |
|
completedCount |
Количество завершений пункта |
|
members |
Массив объектов с описанием участников. Если данных нет, возвращается пустой массив |
|
attachments |
Объект с описанием вложений. Если данных нет, возвращается пустой массив |
|
nodeId |
Служебный идентификатор узла, если используется |
|
templateId |
Идентификатор шаблона задачи |
Объект members
|
Название |
Описание |
|
id |
Идентификатор пользователя |
|
type |
Роль пользователя в пункте чек-листа. Возможные значения:
|
|
name |
Имя пользователя |
|
personalPhoto |
Идентификатор файла с аватаром пользователя на Диске |
|
personalGender |
Пол пользователя. Возможные значения:
|
|
image |
Ссылка на аватар пользователя |
|
isCollaber |
Признак, что пользователь является внешним участником |
Объект attachments
|
Название |
Описание |
|
attachmentId |
Идентификатор файла на Диске в формате |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Доступ к шаблону задачи запрещен"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Доступ к шаблону задачи запрещен |
Недостаточно прав на чтение шаблона |
|
|
|
Could not find value for parameter |
Не передан обязательный параметр |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжить изучение
- Добавить пункт чек-листа в шаблон задачи tasks.template.checklist.add
- Обновить пункт чек-листа шаблона задачи tasks.template.checklist.update
- Получить пункт чек-листа шаблона задачи tasks.template.checklist.get
- Удалить пункт чек-листа шаблона задачи tasks.template.checklist.delete
- Переместить пункт чек-листа после другого tasks.template.checklist.moveAfter
- Переместить пункт чек-листа перед другим tasks.template.checklist.moveBefore
- Завершить пункт чек-листа шаблона задачи tasks.template.checklist.complete
- Возобновить пункт чек-листа шаблона задачи tasks.template.checklist.renew
- Добавить вложение в пункт чек-листа по содержимому tasks.template.checklist.addAttachmentByContent
- Добавить вложения из Диска в пункт чек-листа tasks.template.checklist.addAttachmentsFromDisk
- Удалить вложения из пункта чек-листа tasks.template.checklist.removeAttachments