tasks.template.checklist.list
Получить список пунктов чек-листа шаблона задачи
Описание
Метод tasks.template.checklist.list возвращает список пунктов чек-листа шаблона задачи.
Параметры
templateId
integer
обязательный
Идентификатор шаблона задачи.
Идентификатор шаблона задачи можно получить при создании нового шаблона
filter
object
необязательный
Фильтр выборки пунктов чек-листа вида { "поле": "значение", ... }.
Фильтровать можно по полям:
- ID — идентификатор пункта чек-листа
- TEMPLATE_ID — идентификатор шаблона задачи
- PARENT_ID — идентификатор родительского пункта
- TITLE — текст пункта чек-листа
- SORT_INDEX — индекс сортировки
- IS_COMPLETE — статус выполнения пункта
- IS_IMPORTANT — отметка важности пункта
Параметр templateId принудительно добавляется в фильтр как TEMPLATE_ID, даже если в filter передано другое значение
select
array
необязательный
Список полей для выборки.
В выборке можно указать поля:
- ID — идентификатор пункта чек-листа
- TEMPLATE_ID — идентификатор шаблона задачи
- PARENT_ID — идентификатор родительского пункта
- TITLE — текст пункта чек-листа
- SORT_INDEX — индекс сортировки
- IS_COMPLETE — статус выполнения пункта
- IS_IMPORTANT — отметка важности пункта
- MEMBERS — список участников пункта
- ATTACHMENTS — список вложений пункта
order
object
необязательный
Объект для сортировки результата вида { "поле": "значение сортировки", ... }.
Сортировать можно по полям:
- ID — идентификатор пункта чек-листа
- PARENT_ID — идентификатор родительского пункта
- CREATED_BY — идентификатор автора пункта
- TITLE — текст пункта чек-листа
- SORT_INDEX — индекс сортировки
- IS_COMPLETE — статус выполнения пункта
- IS_IMPORTANT — отметка важности пункта
- TOGGLED_BY — идентификатор пользователя, который последний раз сменил статус пункта
- TOGGLED_DATE — дата и время изменения статуса пункта
Направление сортировки может принимать значения:
- asc — по возрастанию
- desc — по убыванию
По умолчанию результат сортируется по ID в порядке убывания
Примеры запроса
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.template.checklist.list(
template_id=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",
},
).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(
'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
object
Объект с данными ответа (подробное описание)
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Доступ к шаблону задачи запрещен"
}
| Код | Описание | Значение |
|---|---|---|
400 |
0 |
Доступ к шаблону задачи запрещен |
400 |
100 |
Could not find value for parameter {templateId} |

