Получить список пунктов чек-листа шаблона задачи tasks.template.checklist.list

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: пользователь с правом чтения шаблона задачи

Метод tasks.template.checklist.list возвращает список пунктов чек-листа шаблона задачи.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

templateId*
integer

Идентификатор шаблона задачи.

Идентификатор шаблона задачи можно получить при создании нового шаблона или методом получения списка шаблонов

filter
object

Фильтр выборки пунктов чек-листа вида { "поле": "значение", ... }.

Фильтровать можно по полям:

  • ID — идентификатор пункта чек-листа
  • TEMPLATE_ID — идентификатор шаблона задачи
  • PARENT_ID — идентификатор родительского пункта
  • TITLE — текст пункта чек-листа
  • SORT_INDEX — индекс сортировки
  • IS_COMPLETE — статус выполнения пункта
  • IS_IMPORTANT — отметка важности пункта: Y — важный, N — обычный

Статус и важность можно передать как Y и N или как true и false. Поля не из списка метод пропускает без ошибки.

Параметр templateId принудительно добавляется в фильтр как TEMPLATE_ID, даже если в filter передано другое значение

select
array

Список полей для выборки. Если параметр не передан, метод возвращает все поля.

В выборке можно указать поля:

  • ID — идентификатор пункта чек-листа
  • TEMPLATE_ID — идентификатор шаблона задачи
  • PARENT_ID — идентификатор родительского пункта
  • TITLE — текст пункта чек-листа
  • SORT_INDEX — индекс сортировки
  • IS_COMPLETE — статус выполнения пункта
  • IS_IMPORTANT — отметка важности пункта
  • MEMBERS — список участников пункта
  • ATTACHMENTS — список вложений пункта

Если в select нет поля ID, идентификатор остается только ключом элемента в checkListItems

order
object

Объект для сортировки результата вида { "поле": "значение сортировки", ... }.

Сортировать можно по полям:

  • ID — идентификатор пункта чек-листа
  • TEMPLATE_ID — идентификатор шаблона задачи
  • PARENT_ID — идентификатор родительского пункта
  • TITLE — текст пункта чек-листа
  • SORT_INDEX — индекс сортировки
  • IS_COMPLETE — статус выполнения пункта
  • IS_IMPORTANT — отметка важности пункта

Направление сортировки может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

Поля не из списка метод пропускает без ошибки.

По умолчанию результат сортируется по TEMPLATE_ID по убыванию, затем по SORT_INDEX по возрастанию и по ID по убыванию

Метод возвращает все подходящие пункты одним ответом. Постраничной выборки у метода нет, параметр start он не учитывает.

Примеры кода

Как использовать примеры в документации

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 all matching items in one response:
  // the method has no pagination and ignores `start`, so a single call.make is enough
  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',
      },
    },
    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 all matching items in one response:
      // the method has no pagination and ignores `start`, so a single call.make is enough
      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',
          },
        },
        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

Информация о времени выполнения запроса

Объект result

Название
тип

Описание

checkListItems
object

Объект, в котором ключ — идентификатор пункта чек-листа, а значение — описание пункта (подробное описание).

Элементы идут в порядке сортировки из order. В JavaScript объект с числовыми ключами перебирается по возрастанию ключей, поэтому для вывода в нужном порядке сортируйте элементы по sortIndex и parentId.

Если пунктов нет, возвращается пустой массив []

Объект checkListItem

Набор полей зависит от параметра select: в ответ попадают только перечисленные в нем поля. Если select не передан, возвращаются все поля из таблицы.

Метод возвращает значения строками, кроме parentId корневого пункта — он приходит числом 0. Этим ответ отличается от методов tasks.template.checklist.get и tasks.template.checklist.add, где числа и флаги типизированы.

Название
тип

Описание

id
string

Идентификатор пункта чек-листа

templateId
string

Идентификатор шаблона задачи

parentId
string | integer

Идентификатор родительского пункта. Для корневого пункта — число 0

title
string

Текст пункта чек-листа

sortIndex
string

Индекс сортировки среди пунктов одного уровня. Чем меньше значение, тем выше пункт

isComplete
string

Статус выполнения пункта:

  • Y — выполнен
  • N — не выполнен

isImportant
string

Отметка важности пункта:

  • Y — важный
  • N — обычный

members
array

Массив участников пункта (подробное описание).

Если участников нет, возвращается пустой массив []

attachments
object

Объект, в котором ключ — идентификатор прикрепления, а значение — описание файла (подробное описание).

Если вложений нет, возвращается пустой массив []

Объект members

Название
тип

Описание

id
string

Идентификатор пользователя

type
string

Роль пользователя в пункте чек-листа:

  • A — соисполнитель
  • U — наблюдатель

name
string

Имя и фамилия пользователя

personalPhoto
string

Идентификатор файла с аватаром пользователя

personalGender
string

Пол пользователя:

  • M — мужчина
  • F — женщина
  • пустая строка — не указан

image
string

Ссылка на аватар пользователя

isCollaber
boolean

Признак, что пользователь — внешний участник из коллабы

Объект attachments

Пример значения:

"attachments": {
    "621": {
        "attachmentId": 621,
        "name": "report.txt",
        "size": "28",
        "fileId": "10921",
        "downloadUrl": "/bitrix/tools/disk/uf.php?attachedId=621&action=download&ncc=1",
        "viewUrl": "/bitrix/tools/disk/uf.php?attachedId=621&action=show&ncc=1"
    }
}

Название
тип

Описание

attachmentId
integer

Идентификатор прикрепления. Передайте его в параметре attachmentsIds метода tasks.template.checklist.removeAttachments, чтобы удалить вложение

name
string

Имя файла

size
string

Размер файла в байтах

fileId
string

Идентификатор файла на Диске

downloadUrl
string

Относительная ссылка для скачивания файла

viewUrl
string

Относительная ссылка для просмотра файла

Обработка ошибок

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Доступ к шаблону задачи запрещен"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

400

100

Could not find value for parameter

Не передан обязательный параметр templateId

400

100

Invalid value {abc} to match with parameter {templateId}. Should be value of type int.

В templateId передано значение, которое нельзя привести к числу

400

0

Доступ к шаблону задачи запрещен

Недостаточно прав на чтение шаблона

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

403

FEATURE_NOT_AVAILABLE_ON_CURRENT_PLAN
Функция недоступна на текущем тарифе.

Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжить изучение