Получить список шаблонов documentgenerator.template.list

Scope: documentgenerator

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

Метод documentgenerator.template.list возвращает список шаблонов по фильтру.

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

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

Название `тип`	Описание
select `array`	Массив полей, которые нужно вернуть. По умолчанию — `["*"]`. Для `field_N` используйте поля из таблицы полей. Чтобы получить коды доступа и провайдеры, добавьте в `select` поля `users` и `providers`
order `object`	Объект для сортировки шаблонов в формате `{"field_1":"value_1", ... "field_N":"value_N"}`. Направление сортировки может принимать значения: `asc` — по возрастанию `desc` — по убыванию Для `field_N` используйте поля из таблицы полей.
filter `object`	Объект для фильтрации шаблонов в формате `{"field_1":"value_1", ... "field_N":"value_N"}`. Для `field_N` используйте поля из таблицы полей. К ключам `field_n` можно добавить префикс, уточняющий работу фильтра. Возможные значения префикса: `>=` — больше либо равно `>` — больше `<=` — меньше либо равно `<` — меньше `@` — IN, в качестве значения передается массив `!@` — NOT IN, в качестве значения передается массив `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры: `"мол%"` — ищет значения, начинающиеся с «мол» `"%мол"` — ищет значения, заканчивающиеся на «мол» `"%мол%"` — ищет значения, где «мол» может быть в любой позиции `%=` — LIKE (аналогично `=%`) `=` — равно, точное совпадение (используется по умолчанию) `!=` — не равно `!` — не равно По умолчанию применяется фильтр `isDeleted = "N"`
start `integer`	Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение `50`. Чтобы выбрать третью страницу результатов — значение `100` и так далее. Формула расчета значения параметра `start`: `start = (N — 1) * 50`, где `N` — номер нужной страницы

Поля для select, order, filter

Название `тип`	Описание
id `integer`	Идентификатор шаблона
active `char`	Активность шаблона. Возможные значения: `Y` — активен `N` — не активен
name `string`	Название шаблона
code `string`	Символьный код шаблона
region `string`	Регион шаблона
sort `integer`	Индекс сортировки
createTime `datetime`	Дата и время создания
updateTime `datetime`	Дата и время обновления
numeratorId `integer`	Идентификатор нумератора
withStamps `char`	Использование печатей и подписей. Возможные значения: `Y` — да `N` — нет
users `array`	Коды доступа к шаблону. Только для `select`
providers `array`	Провайдеры данных шаблона. Только для `select`

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "select": [
              "*",
              "users",
              "providers"
            ],
            "order": {
              "id": "desc"
            },
            "filter": {
              "region": "ru",
              "active": "Y",
              ">=createTime": "2026-03-18T00:00:00+03:00"
            },
            "start": 0
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "select": [
              "*",
              "users",
              "providers"
            ],
            "order": {
              "id": "desc"
            },
            "filter": {
              "region": "ru",
              "active": "Y",
              ">=createTime": "2026-03-18T00:00:00+03:00"
            },
            "start": 0,
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.template.list

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.template.list',
                {
                    select: ['*', 'users', 'providers'],
                    order: {
                        id: 'desc'
                    },
                    filter: {
                        region: 'ru',
                        active: 'Y',
                        '>=createTime': '2026-03-18T00:00:00+03:00'
                    },
                    start: 0
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.template.list',
                [
                    'select' => ['*', 'users', 'providers'],
                    'order' => [
                        'id' => 'desc'
                    ],
                    'filter' => [
                        'region' => 'ru',
                        'active' => 'Y',
                        '>=createTime' => '2026-03-18T00:00:00+03:00'
                    ],
                    'start' => 0,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.template.list',
            {
                select: ['*', 'users', 'providers'],
                order: {
                    id: 'desc'
                },
                filter: {
                    region: 'ru',
                    active: 'Y',
                    '>=createTime': '2026-03-18T00:00:00+03:00'
                },
                start: 0
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.template.list',
            [
                'select' => ['*', 'users', 'providers'],
                'order' => [
                    'id' => 'desc'
                ],
                'filter' => [
                    'region' => 'ru',
                    'active' => 'Y',
                    '>=createTime' => '2026-03-18T00:00:00+03:00'
                ],
                'start' => 0,
            ]
        );
        
        print_r($result);

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "templates": {
                    "57": {
                        "id": "57",
                        "active": "Y",
                        "name": "SUPPLY_CONTRACT_NEW Template",
                        "code": "REST_TEMPLATE",
                        "region": "ru",
                        "sort": "700",
                        "createTime": "2026-03-23T16:51:25+03:00",
                        "updateTime": "2026-03-23T17:26:39+03:00",
                        "createdBy": "503",
                        "updatedBy": "503",
                        "moduleId": "rest",
                        "fileId": "5641",
                        "bodyType": "Bitrix\\DocumentGenerator\\Body\\Docx",
                        "numeratorId": "3",
                        "withStamps": "N",
                        "productsTableVariant": "",
                        "isDeleted": "N",
                        "isDefault": "N",
                        "download": "/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=57",
                        "providers": [
                            "bitrix\\documentgenerator\\dataprovider\\rest"
                        ],
                        "users": [
                            "U503"
                        ],
                        "downloadMachine": "https://mysite.ru/rest/documentgenerator.api.template.download.json?auth=3f5cc2690000071b00000844000001f7f0f107506cefda4aa5b9d0dc80371e7f0f7e26&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZTSVRFX0lEPXMxJmlkPTU3Jl89RFB3MHZYN1A3RXdiMm5EenY2VFYyc1Vkb0hPejA3SlM%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZHxkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzUwWlcxd2JHRjBaUzVrYjNkdWJHOWhaQ1pUU1ZSRlgwbEVQWE14Sm1sa1BUVTNKbDg5UkZCM01IWllOMUEzUlhkaU1tNUVlblkyVkZZeWMxVmtiMGhQZWpBM1NsTT18M2Y1Y2MyNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDc1MDZjZWZkYTRhYTViOWQwZGM4MDM3MWU3ZjBmN2UyNiI%3D.XuC83kQJE21vRoqv1%2FgdT8OiYq4JdpiSLxumy%2F1UcB0%3D"
                    },
                    "53": {
                        "id": "53", // описание следующего шаблона
                        ...
                    },
                    "51": {
                        "id": "51", // описание следующего шаблона
                        ...
                    }
                }
            },
            "total": 3,
            "time": {
                "start": 1774341679,
                "finish": 1774341679.641056,
                "duration": 0.6410560607910156,
                "processing": 0,
                "date_start": "2026-03-24T11:41:19+03:00",
                "date_finish": "2026-03-24T11:41:19+03:00",
                "operating_reset_at": 1774342279,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object`	Корневой элемент ответа (подробное описание)
total `integer`	Общее количество шаблонов в списке
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
templates `object`	Объект шаблонов, где ключом выступает `id`, а значением — данные шаблона (подробное описание)

Элемент объекта templates

Название `тип`	Описание
id `string`	Идентификатор шаблона
active `char`	Активность шаблона. Возможные значения: `Y` — активен `N` — не активен
name `string`	Название шаблона
code `string`	Символьный код шаблона
region `string`	Регион шаблона
sort `string`	Индекс сортировки
createTime `datetime`	Дата и время создания
updateTime `datetime`	Дата и время обновления
createdBy `string`	Идентификатор пользователя, который создал шаблон
updatedBy `string`	Идентификатор пользователя, который обновил шаблон
moduleId `string`	Идентификатор модуля
fileId `string`	Идентификатор файла шаблона
bodyType `string`	Класс типа тела шаблона
numeratorId `string`	Идентификатор нумератора
withStamps `char`	Использование печатей и подписей. Возможные значения: `Y` — да `N` — нет
productsTableVariant `string`	Вариант таблицы товаров
isDeleted `char`	Признак удаления шаблона. Возможные значения: `Y` — удален `N` — не удален
isDefault `char`	Признак шаблона по умолчанию. Возможные значения: `Y` — да `N` — нет
download `string`	Ссылка на скачивание шаблона
downloadMachine `string`	Ссылка на скачивание шаблона для машинной обработки
users `array`	Массив кодов доступа, если поле выбрано в `select`
providers `array`	Массив провайдеров, если поле выбрано в `select`

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "You do not have permissions to modify templates"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус	Код	Описание	Значение
`400`	`0`	You do not have permissions to modify templates	Недостаточно прав для получения списка шаблонов

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Получить шаблон по id

Удалить шаблон

Получить список шаблонов documentgenerator.template.list

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

Поля для select, order, filterПоля для select, order, filter

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект resultОбъект result

Элемент объекта templatesЭлемент объекта templates

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

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

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

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