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

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

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

Scope: documentgenerator

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

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

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

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

Название
тип

Описание

select
array

Массив содержит список полей, которые нужно вернуть.

По умолчанию ["*"]

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 (аналогично =%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N — 1) * 50, где N — номер нужной страницы

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

Название
тип

Описание

id
integer

Идентификатор документа

title
string

Название документа

number
string

Номер документа

templateId
integer

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

provider
string

Класс провайдера

value
string

Внешний идентификатор объекта

fileId
integer

Идентификатор DOCX-файла документа

imageId
integer

Идентификатор файла изображения документа

pdfId
integer

Идентификатор PDF-файла документа

createTime
datetime

Время создания документа

updateTime
datetime

Время обновления документа

values
object

Значения полей документа

createdBy
integer

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

updatedBy
integer

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

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "select": [
              "id",
              "title",
              "number",
              "templateId",
              "provider",
              "value",
              "fileId",
              "imageId",
              "pdfId",
              "createTime",
              "updateTime",
              "createdBy"
            ],
            "order": {
              "updateTime": "desc",
              "id": "desc"
            },
            "filter": {
              ">=createTime": "2026-03-18T00:00:00+03:00",
              "%title": "ДГ-2026"
            },
            "start": 0
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.document.list
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "select": [
              "id",
              "title",
              "number",
              "templateId",
              "provider",
              "value",
              "fileId",
              "imageId",
              "pdfId",
              "createTime",
              "updateTime",
              "createdBy"
            ],
            "order": {
              "updateTime": "desc",
              "id": "desc"
            },
            "filter": {
              ">=createTime": "2026-03-18T00:00:00+03:00",
              "%title": "ДГ-2026"
            },
            "start": 0,
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.document.list
        
try
        {
            const response = await $b24.callMethod(
                'documentgenerator.document.list',
                {
                    select: [
                        'id',
                        'title',
                        'number',
                        'templateId',
                        'provider',
                        'value',
                        'fileId',
                        'imageId',
                        'pdfId',
                        'createTime',
                        'updateTime',
                        'createdBy'
                    ],
                    order: {
                        updateTime: 'desc',
                        id: 'desc'
                    },
                    filter: {
                        '>=createTime': '2026-03-18T00:00:00+03:00',
                        '%title': 'ДГ-2026'
                    },
                    start: 0
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service->core->call(
                'documentgenerator.document.list',
                [
                    'select' => [
                        'id',
                        'title',
                        'number',
                        'templateId',
                        'provider',
                        'value',
                        'fileId',
                        'imageId',
                        'pdfId',
                        'createTime',
                        'updateTime',
                        'createdBy',
                    ],
                    'order' => [
                        'updateTime' => 'desc',
                        'id' => 'desc',
                    ],
                    'filter' => [
                        '>=createTime' => '2026-03-18T00:00:00+03:00',
                        '%title' => 'ДГ-2026',
                    ],
                    'start' => 0,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'documentgenerator.document.list',
            {
                select: [
                    'id',
                    'title',
                    'number',
                    'templateId',
                    'provider',
                    'value',
                    'fileId',
                    'imageId',
                    'pdfId',
                    'createTime',
                    'updateTime',
                    'createdBy'
                ],
                order: {
                    updateTime: 'desc',
                    id: 'desc'
                },
                filter: {
                    '>=createTime': '2026-03-18T00:00:00+03:00',
                    '%title': 'ДГ-2026'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
        
                    if (result.more())
                    {
                        result.next();
                    }
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.document.list',
            [
                'select' => [
                    'id',
                    'title',
                    'number',
                    'templateId',
                    'provider',
                    'value',
                    'fileId',
                    'imageId',
                    'pdfId',
                    'createTime',
                    'updateTime',
                    'createdBy',
                ],
                'order' => [
                    'updateTime' => 'desc',
                    'id' => 'desc',
                ],
                'filter' => [
                    '>=createTime' => '2026-03-18T00:00:00+03:00',
                    '%title' => 'ДГ-2026',
                ],
                'start' => 0,
            ]
        );
        
        print_r($result);

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

HTTP-статус: 200

{
            "result": {
                "documents": [
                    {
                        "id": "51",
                        "title": "SUPPLY_CONTRACT Template 1773843147554 ДГ-2026-001",
                        "number": "ДГ-2026-001",
                        "templateId": "53",
                        "provider": "bitrix\\documentgenerator\\dataprovider\\rest",
                        "value": "SUPPLY_CONTRACT_2026_015",
                        "fileId": "241",
                        "imageId": "243",
                        "pdfId": "245",
                        "createTime": "2026-03-18T17:27:48+03:00",
                        "updateTime": "2026-03-18T17:27:48+03:00",
                        "createdBy": "503",
                        "downloadUrl": "https://mysite.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&SITE_ID=s1&id=51",
                        "pdfUrl": "https://mysite.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getpdf&SITE_ID=s1&id=51",
                        "imageUrl": "https://mysite.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getimage&SITE_ID=s1&id=51",
                        "values": null,
                        "stampsEnabled": false,
                        "downloadUrlMachine": "https://mysite.ru/rest/documentgenerator.api.document.getfile.json?auth=63bfbb690000071b00000844000001f7f0f107a3f045d88e8327666879f4b04885d7af&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlJlNJVEVfSUQ9czEmaWQ9NTEmXz1WMXA5WU1YMkRSbUJraDA1cmhjVVRIZXFkRE5EWmpLcA%3D%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlfGRvY3VtZW50Z2VuZXJhdG9yfFlXTjBhVzl1UFdSdlkzVnRaVzUwWjJWdVpYSmhkRzl5TG1Gd2FTNWtiMk4xYldWdWRDNW5aWFJtYVd4bEpsTkpWRVZmU1VROWN6RW1hV1E5TlRFbVh6MVdNWEE1V1UxWU1rUlNiVUpyYURBMWNtaGpWVlJJWlhGa1JFNUVXbXBMY0E9PXw2M2JmYmI2OTAwMDAwNzFiMDAwMDA4NDQwMDAwMDFmN2YwZjEwN2EzZjA0NWQ4OGU4MzI3NjY2ODc5ZjRiMDQ4ODVkN2FmIg%3D%3D.b2USzpTXZIDIUEgZjOXB4hDphKJjQY5spzTOdimZvss%3D",
                        "pdfUrlMachine": "https://mysite.ru/rest/documentgenerator.api.document.getpdf.json?auth=63bfbb690000071b00000844000001f7f0f107a3f045d88e8327666879f4b04885d7af&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRwZGYmU0lURV9JRD1zMSZpZD01MSZfPUgyc0IwUlpMa1BueVpvV29rajVHUnFHUWU1T0cwQ2Z1%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRwZGZ8ZG9jdW1lbnRnZW5lcmF0b3J8WVdOMGFXOXVQV1J2WTNWdFpXNTBaMlZ1WlhKaGRHOXlMbUZ3YVM1a2IyTjFiV1Z1ZEM1blpYUndaR1ltVTBsVVJWOUpSRDF6TVNacFpEMDFNU1pmUFVneWMwSXdVbHBNYTFCdWVWcHZWMjlyYWpWSFVuRkhVV1UxVDBjd1EyWjF8NjNiZmJiNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDdhM2YwNDVkODhlODMyNzY2Njg3OWY0YjA0ODg1ZDdhZiI%3D.m0Ng5a%2BitODVrxQonwPkRt9L8dr2Jx9fbxnY%2BoZzAe4%3D",
                        "imageUrlMachine": "https://mysite.ru/rest/documentgenerator.api.document.getimage.json?auth=63bfbb690000071b00000844000001f7f0f107a3f045d88e8327666879f4b04885d7af&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRpbWFnZSZTSVRFX0lEPXMxJmlkPTUxJl89RGJHM3pFUTlPTmhYNVlrWUc3NEx6MTVUYUdzdlVkUGk%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRpbWFnZXxkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzVrYjJOMWJXVnVkQzVuWlhScGJXRm5aU1pUU1ZSRlgwbEVQWE14Sm1sa1BUVXhKbDg5UkdKSE0zcEZVVGxQVG1oWU5WbHJXVWMzTkV4Nk1UVlVZVWR6ZGxWa1VHaz18NjNiZmJiNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDdhM2YwNDVkODhlODMyNzY2Njg3OWY0YjA0ODg1ZDdhZiI%3D.40ZdIhNinEEmMsb%2FQm%2BCseG%2BKe0ZmR6vpQhs6N6KjfQ%3D"
                    },
                    {
                        "id": "37",
                        ... // описание документа с id=37
                    },
                    {
                        "id": "33",
                        ... // описание документа с id=33
                    }
                ]
            },
            "total": 3,
            "time": {
                "start": 1773908326,
                "finish": 1773908326.204212,
                "duration": 0.20421195030212402,
                "processing": 0,
                "date_start": "2026-03-19T11:18:46+03:00",
                "date_finish": "2026-03-19T11:18:46+03:00",
                "operating_reset_at": 1773908926,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа (подробное описание)

total
integer

Общее количество элементов по фильтру

time
time

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

Объект result

Название
тип

Описание

documents
array

Список документов.

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

Элемент массива documents

Название
тип

Описание

id
string

Идентификатор документа

title
string

Название документа

number
string

Номер документа

templateId
string

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

provider
string

Класс провайдера данных

value
string

Внешний идентификатор объекта

fileId
integer

Идентификатор DOCX-файла документа

imageId
integer

Идентификатор файла изображения документа

pdfId
integer

Идентификатор PDF-файла документа

createTime
datetime

Время создания документа

updateTime
datetime

Время последнего обновления документа

values
object

Значения полей документа (подробное описание)

createdBy
string

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

updatedBy
integer

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

downloadUrl
string

Ссылка на скачивание DOCX для пользователя

pdfUrl
string

Ссылка на скачивание PDF для пользователя

imageUrl
string

Ссылка на скачивание изображения для пользователя

stampsEnabled
boolean

Признак включенных печатей и подписей

downloadUrlMachine
string

Ссылка на скачивание DOCX для приложения

pdfUrlMachine
string

Ссылка на скачивание PDF для приложения

imageUrlMachine
string

Ссылка на скачивание изображения для приложения

Объект values

Название
тип

Описание

_creationMethod
string

Способ создания документа

stampsEnabled
boolean

Признак включенных печатей и подписей

<код_поля>
string

Значение поля из шаблона по его коду

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "You do not have permissions to view documents"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

400

0

You do not have permissions to view documents

Недостаточно прав на просмотр списка документов

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

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

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

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

Предыдущая
Получить документ по идентификатору
Следующая
Удалить документ