метод REST scope: documentgenerator

documentgenerator.document.list

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

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

Описание

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

Ответ

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

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

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "You do not have permissions to view documents"
}
Код Описание Значение
400 0 You do not have permissions to view documents

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

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.