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

Scope: crm

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

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

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

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

Название `тип`	Описание
select `array`	Список полей, которые нужно вернуть у шаблонов. При выборке можно использовать: `''` — для выборки всех стандартных полей шаблона явный список полей, например `["id","name","region","active"]` Дополнительно поддерживаются: `entityTypeId` — массив привязок шаблона к CRM-объектам `users` — массив кодов прав доступа Основные поля для `select`: `id`, `name`, `region`, `code`, `active`, `moduleId`, `numeratorId`, `withStamps`, `isDeleted`, `sort`, `createTime`, `updateTime` Список полей шаблона смотрите в разделе `Тип template`. По умолчанию используется `[""]`
filter `object`	Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }` где: `field_n` — название поля для фильтрации `value_n` — значение фильтра К ключам `field_n` можно добавлять префиксы: `>=` — больше либо равно `>` — больше `<=` — меньше либо равно `<` — меньше `@` — IN, в значении передается массив `!@` — NOT IN, в значении передается массив `=` — равно (по умолчанию) `!=` или `!` — не равно Особенности: если `isDeleted` не передан, применяется фильтр `isDeleted = "N"` фильтр `moduleId` принудительно ограничивается значением `crm` можно фильтровать по `entityTypeId`, например `["2","2_category_37"]` Основные поля для `filter`: `id`, `name`, `region`, `code`, `active`, `moduleId`, `numeratorId`, `withStamps`, `isDeleted`, `sort`, `createTime`, `updateTime`, `entityTypeId`
order `object`	Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }` где: `field_n` — название поля сортировки `value_n` — направление сортировки: `ASC` или `DESC` Основные поля для `order`: `id`, `name`, `region`, `code`, `active`, `moduleId`, `numeratorId`, `withStamps`, `isDeleted`, `sort`, `createTime`, `updateTime` Пример: `{"id":"DESC","sort":"ASC"}`
start `integer`	Параметр постраничной навигации. Размер страницы фиксирован: `50` записей. Формула для получения N-й страницы: `start = (N - 1) * 50` Подробнее в статье Особенности списочных методов

Примеры кода

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

Пример получения списка шаблонов, где:

выбираются поля id, name, region, entityTypeId, users
сортировка по id по убыванию
фильтр по региону ru и активности Y
стартовое смещение — 0

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","name","region","entityTypeId","users"],"order":{"id":"desc"},"filter":{"region":"ru","active":"Y"},"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.template.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","name","region","entityTypeId","users"],"order":{"id":"desc"},"filter":{"region":"ru","active":"Y"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.template.list

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.template.list',
        		{
        			select: ['id', 'name', 'region', 'entityTypeId', 'users'],
        			order: { id: 'desc' },
        			filter: { region: 'ru', active: 'Y' },
        			start: 0,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.template.list',
                    [
                        'select' => ['id', 'name', 'region', 'entityTypeId', 'users'],
                        'order' => ['id' => 'desc'],
                        'filter' => ['region' => 'ru', 'active' => 'Y'],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting templates list: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.template.list',
            {
                select: ['id', 'name', 'region', 'entityTypeId', 'users'],
                order: { id: 'desc' },
                filter: { region: 'ru', active: 'Y' },
                start: 0,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.template.list',
            [
                'select' => ['id', 'name', 'region', 'entityTypeId', 'users'],
                'order' => ['id' => 'desc'],
                'filter' => ['region' => 'ru', 'active' => 'Y'],
                'start' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "templates": {
                    "39": {
                        "id": "39",
                        "name": "Демонстрационная реализация товара",
                        "region": "ru",
                        "download": "https://mysite.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.template.download&SITE_ID=s1&id=39",
                        "users": [
                            "UA"
                        ],
                        "entityTypeId": [
                            "2_category_0",
                            "2_category_32"
                        ],
                        "downloadMachine": "https://mysite.ru/rest/crm.documentgenerator.template.download.json?auth=***&token=***"
                    },
                    "37": {
                        "id": "37",
                        "name": "Акт о списании товаров (Россия)",
                        "region": "ru",
                        "download": "https://mysite.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.template.download&SITE_ID=s1&id=37",
                        "users": [
                            "UA"
                        ],
                        "entityTypeId": [
                            "2_category_37",
                            "bitrix\\crm\\integration\\documentgenerator\\dataprovider\\storedocumentdeduct"
                        ],
                        "downloadMachine": "https://mysite.ru/rest/crm.documentgenerator.template.download.json?auth=***&token=***"
                    }
                }
            },
            "total": 20,
            "time": {
                "start": 1773845479,
                "finish": 1773845479.829607,
                "duration": 0.8296070098876953,
                "processing": 0,
                "date_start": "2026-03-18T17:51:19+03:00",
                "date_finish": "2026-03-18T17:51:19+03:00",
                "operating_reset_at": 1773846079,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа. Содержит объект `templates`
total `integer`	Общее количество шаблонов, подходящих под фильтр
time `time`	Информация о времени выполнения запроса

Объект templates

object, где ключ — строковый идентификатор шаблона, а значение — объект template

Тип template

Название `тип`	Описание
id `string`	Идентификатор шаблона
name `string`	Название шаблона
region `string`	Регион шаблона
download `string`	Ссылка для скачивания шаблона
users `array`	Массив кодов пользователей или групп доступа
entityTypeId `array`	Массив привязок к типам объектов
downloadMachine `string`	Ссылка для машинного скачивания шаблона
code `string`	Символьный код шаблона. Может быть `null`
active `char`	Признак активности (`Y`/`N`)
moduleId `string`	Идентификатор модуля владельца шаблона
numeratorId `integer`	Идентификатор нумератора
withStamps `char`	Признак использования печатей (`Y`/`N`)
isDeleted `char`	Признак удаления (`Y`/`N`)
sort `integer`	Индекс сортировки
createTime `datetime`	Время создания шаблона
updateTime `datetime`	Время последнего обновления шаблона

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

HTTP-статус: 400

{
            "error": "DOCGEN_ACCESS_ERROR",
            "error_description": "Access denied"
        }

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

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

Код	Описание	Значение
`DOCGEN_ACCESS_ERROR`	Access denied	Нет доступа к шаблонам
`Пустое значение`	You do not have permissions to modify templates	Недостаточно прав для изменения шаблонов генератора документов
`Пустое значение`	Module documentgenerator is not installed	Модуль `documentgenerator` недоступен

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

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

Удалить шаблон документа

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

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

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

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

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

Объект templatesОбъект templates

Тип templateТип template

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

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

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

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