метод REST scope: crm

crm.documentgenerator.template.list

Получить список шаблонов документов

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

Описание

Метод 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

Подробнее в статье Особенности списочных методов

Примеры запроса

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

Ответ

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

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

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

HTTP-статус: 400

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

Что будем искать? Например,Продвижение