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

Scope: crm

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

Метод crm.documentgenerator.document.list возвращает список документов по фильтру.

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

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

Название `тип`	Описание
select `string[]`	Список полей, которые должны быть заполнены у документов в выборке. При выборке можно использовать: `''` — для выборки всех стандартных полей документа явный список полей, например `['id','title','number','entityId','createTime']` Список полей смотрите в разделе Тип document. По умолчанию используется `['']`
filter `object`	Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }` где: `field_n` — название поля для фильтрации `value_n` — значение фильтра К ключам `field_n` можно добавлять префиксы: `>=` — больше либо равно `>` — больше `<=` — меньше либо равно `<` — меньше `@` — IN, в значении передается массив `!@` — NOT IN, в значении передается массив `=` — равно (по умолчанию) `!=` или `!` — не равно Список доступных полей для фильтрации смотрите в разделе Тип document.
order `object`	Объект формата: `{ field_1: value_1, field_2: value_2, ..., field_n: value_n }` где: `field_n` — название поля сортировки `value_n` — направление сортировки: `ASC` или `DESC` Список полей для сортировки смотрите в разделе Тип document. Пример: `{"id":"DESC","createTime":"ASC"}`
start `integer`	Параметр постраничной навигации. Размер страницы фиксирован: `50` записей. Формула для получения N-й страницы: `start = (N - 1) * 50` Подробнее в статье Особенности списочных методов

Примеры кода

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

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

выбираются поля id, title, number, entityId, createTime
сортировка по id по убыванию
фильтр по entityTypeId = 2 и entityId = 101
стартовое смещение — 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","title","number","entityId","createTime"],"order":{"id":"desc"},"filter":{"entityTypeId":2,"entityId":101},"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.document.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","title","number","entityId","createTime"],"order":{"id":"desc"},"filter":{"entityTypeId":2,"entityId":101},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.document.list

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.document.list',
        		{
        			select: ['id', 'title', 'number', 'entityId', 'createTime'],
        			order: { id: 'desc' },
        			filter: { entityTypeId: 2, entityId: 101 },
        			start: 0,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.document.list',
                    [
                        'select' => ['id', 'title', 'number', 'entityId', 'createTime'],
                        'order' => ['id' => 'desc'],
                        'filter' => ['entityTypeId' => 2, 'entityId' => 101],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting documents list: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.document.list',
            {
                select: ['id', 'title', 'number', 'entityId', 'createTime'],
                order: { id: 'desc' },
                filter: { entityTypeId: 2, entityId: 101 },
                start: 0,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.document.list',
            [
                'select' => ['id', 'title', 'number', 'entityId', 'createTime'],
                'order' => ['id' => 'desc'],
                'filter' => ['entityTypeId' => 2, 'entityId' => 101],
                'start' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "documents": [
                    {
                        "id": "61",
                        "title": "Демонстрационная реализация товара 2026-001",
                        "number": "2026-002",
                        "templateId": "39",
                        "fileId": "283",
                        "imageId": "285",
                        "pdfId": "287",
                        "createTime": "2026-03-20T13:51:45+03:00",
                        "updateTime": "2026-03-20T14:42:38+03:00",
                        "values": {
                            "_creationMethod": "rest",
                            "stampsEnabled": true
                        },
                        "createdBy": "577",
                        "updatedBy": "577",
                        "downloadUrl": "https://bitrix.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.download&SITE_ID=s1&id=61",
                        "pdfUrl": "https://bitrix.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getPdf&SITE_ID=s1&id=61",
                        "imageUrl": "https://bitrix.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getImage&SITE_ID=s1&id=61",
                        "stampsEnabled": true,
                        "entityId": "101",
                        "entityTypeId": "2",
                        "downloadUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.download.json?auth=***&token=***",
                        "pdfUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.getPdf.json?auth=***&token=***",
                        "imageUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.getImage.json?auth=***&token=***"
                    },
                    {
                        "id": "59",
                        "title": "Демонстрационная реализация товара 2026-001",
                        "number": "2026-001",
                        "templateId": "39",
                        "fileId": "271",
                        "imageId": "273",
                        "pdfId": "275",
                        "createTime": "2026-03-20T13:28:26+03:00",
                        "updateTime": "2026-03-20T13:28:26+03:00",
                        "values": {
                            "_creationMethod": "rest",
                            "stampsEnabled": true
                        },
                        "createdBy": "577",
                        "updatedBy": null,
                        "downloadUrl": "https://bitrix.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.download&SITE_ID=s1&id=59",
                        "pdfUrl": "https://bitrix.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getPdf&SITE_ID=s1&id=59",
                        "imageUrl": "https://bitrix.bitrix24.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getImage&SITE_ID=s1&id=59",
                        "stampsEnabled": true,
                        "entityId": "101",
                        "entityTypeId": "2",
                        "downloadUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.download.json?auth=***&token=***",
                        "pdfUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.getPdf.json?auth=***&token=***",
                        "imageUrlMachine": "https://bitrix.bitrix24.ru/rest/crm.documentgenerator.document.getImage.json?auth=***&token=***"
                    }
                ]
            },
            "total": 4,
            "time": {
                "start": 1774009414,
                "finish": 1774009414.09833,
                "duration": 0.09833002090454102,
                "processing": 0,
                "date_start": "2026-03-20T15:23:34+03:00",
                "date_finish": "2026-03-20T15:23:34+03:00",
                "operating_reset_at": 1774010014,
                "operating": 0
            }
        }

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

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

Тип result

Название `тип`	Описание
documents `object[]`	Массив документов. Структура элемента описана в типе `document`

Тип document

Состав полей зависит от параметра select.

Название `тип`	Описание
id `string`	Идентификатор документа
title `string`	Название документа
number `string`	Номер документа
templateId `integer` \| `string`	Идентификатор шаблона документа
entityTypeId `integer` \| `string`	Идентификатор типа CRM-объекта
entityId `integer` \| `string`	Идентификатор CRM-объекта
fileId `integer` \| `string`	Идентификатор DOCX-файла документа
imageId `integer` \| `string`	Идентификатор изображения документа
pdfId `integer` \| `string`	Идентификатор PDF-файла документа
createTime `datetime`	Дата создания документа
updateTime `datetime`	Дата обновления документа
createdBy `integer` \| `string` \| `null`	Идентификатор пользователя, создавшего документ
updatedBy `integer` \| `string` \| `null`	Идентификатор пользователя, обновившего документ
values `object` \| `null`	Значения полей документа
downloadUrl `string`	Ссылка на скачивание документа
imageUrl `string`	Ссылка на изображение документа
pdfUrl `string`	Ссылка на PDF-документ
downloadUrlMachine `string`	Ссылка на скачивание документа для машинного доступа
pdfUrlMachine `string`	Ссылка на PDF-документ для машинного доступа
imageUrlMachine `string`	Ссылка на изображение документа для машинного доступа
stampsEnabled `boolean`	Признак подстановки печати и подписи

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

HTTP-статус: 400

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

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

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

Код	Описание	Значение
`100`	Unknown field definition ENTITY_TYPE_ID (ENTITY_TYPE_ID) for \Bitrix\DocumentGenerator\Model\Document Entity	В параметр `select` передано поле `entityTypeId`, которое не является прямым полем модели документа. Используйте `select: ['*']`
`ACCESS_DENIED`	Access denied	Недостаточно прав для чтения документов по выбранному фильтру CRM-объектов
`Пустое значение`	You do not have permissions to view documents	Недостаточно прав для просмотра документов генератора документов
`Пустое значение`	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.document.list

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

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

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

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

Тип resultТип result

Тип documentТип document

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

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

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

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