Получить список документов crm.documentgenerator.document.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: пользователь с правом "просмотра" документов генератора документов
Метод crm.documentgenerator.document.list возвращает список документов по фильтру.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Список полей, которые должны быть заполнены у документов в выборке. При выборке можно использовать:
Список полей смотрите в разделе Тип document. По умолчанию используется |
|
filter |
Объект формата:
где:
К ключам
Список доступных полей для фильтрации смотрите в разделе Тип document. |
|
order |
Объект формата:
где:
Список полей для сортировки смотрите в разделе Тип document. Пример: |
|
start |
Параметр постраничной навигации. Размер страницы фиксирован: Формула для получения N-й страницы: Подробнее в статье Особенности списочных методов |
Примеры кода
Как использовать примеры в документации
Пример получения списка документов, где:
- выбираются поля
id,title,number,entityId,createTime - сортировка по
idпо убыванию - фильтр по
entityTypeId = 2иentityId = 101 - стартовое смещение —
0
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type DocumentItem = {
id: string
title: string
number: string
templateId: string
entityTypeId: string
entityId: string
fileId: string
imageId: string
pdfId: string
createTime: ISODate
updateTime: ISODate
createdBy: string | null
updatedBy: string | null
values: Record<string, unknown> | null
downloadUrl: string
imageUrl: string
pdfUrl: string
stampsEnabled: boolean
downloadUrlMachine: string
pdfUrlMachine: string
imageUrlMachine: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type DocumentListResult = {
documents: DocumentItem[]
}
try {
// crm.documentgenerator.document.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<DocumentListResult>({
method: 'crm.documentgenerator.document.list',
params: {
select: ['id', 'title', 'number', 'entityId', 'createTime'],
order: { id: 'desc' },
filter: { entityTypeId: 2, entityId: 101 },
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Documents on this page:', result.documents.length, result.documents)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function fetchDocumentList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.documentgenerator.document.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'crm.documentgenerator.document.list',
params: {
select: ['id', 'title', 'number', 'entityId', 'createTime'],
order: { id: 'desc' },
filter: { entityTypeId: 2, entityId: 101 },
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Documents on this page:', result.documents.length, result.documents)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchDocumentList)
</script>
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();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.document.list(
select=["id", "title", "number", "entityId", "createTime"],
order={"id": "desc"},
filter={
"entityTypeId": 2,
"entityId": 101,
},
start=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Пример as_list
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.document.list(
select=["id", "title", "number", "entityId", "createTime"],
order={"id": "desc"},
filter={
"entityTypeId": 2,
"entityId": 101,
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
Пример as_list_fast
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.documentgenerator.document.list(
select=["id", "title", "number", "entityId", "createTime"],
order={"id": "desc"},
filter={
"entityTypeId": 2,
"entityId": 101,
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
BX24.callMethod(
'crm.documentgenerator.document.list',
{
select: ['id', 'title', 'number', 'entityId', 'createTime'],
order: { id: 'desc' },
filter: { entityTypeId: 2, entityId: 101 },
},
(result) => {
if (result.error()) {
console.error(result.error());
return;
}
console.info(result.data());
if (result.more()) {
result.next();
}
},
);
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 |
Корневой объект ответа. Содержит структуру |
|
total |
Общее количество документов, подходящих под фильтр |
|
next |
Смещение для следующей страницы. Возвращается, если есть следующая страница |
|
time |
Информация о времени выполнения запроса |
Тип result
|
Название |
Описание |
|
documents |
Массив документов. Структура элемента описана в типе |
Тип document
Состав полей зависит от параметра select.
|
Название |
Описание |
|
id |
Идентификатор документа |
|
title |
Название документа |
|
number |
Номер документа |
|
Идентификатор шаблона документа |
|
|
Идентификатор типа CRM-объекта |
|
|
Идентификатор CRM-объекта |
|
|
Идентификатор DOCX-файла документа |
|
|
Идентификатор изображения документа |
|
|
Идентификатор PDF-файла документа |
|
|
createTime |
Дата создания документа |
|
updateTime |
Дата обновления документа |
|
Идентификатор пользователя, создавшего документ |
|
|
Идентификатор пользователя, обновившего документ |
|
|
Значения полей документа |
|
|
downloadUrl |
Ссылка на скачивание документа |
|
imageUrl |
Ссылка на изображение документа |
|
pdfUrl |
Ссылка на PDF-документ |
|
downloadUrlMachine |
Ссылка на скачивание документа для машинного доступа |
|
pdfUrlMachine |
Ссылка на PDF-документ для машинного доступа |
|
imageUrlMachine |
Ссылка на изображение документа для машинного доступа |
|
stampsEnabled |
Признак подстановки печати и подписи |
Обработка ошибок
HTTP-статус: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Unknown field definition ENTITY_TYPE_ID (ENTITY_TYPE_ID) for \Bitrix\DocumentGenerator\Model\Document Entity |
В параметр |
|
|
Access denied |
Недостаточно прав для чтения документов по выбранному фильтру CRM-объектов |
|
|
You do not have permissions to view documents |
Недостаточно прав для просмотра документов генератора документов |
|
|
Module documentgenerator is not installed |
Модуль |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать новый документ crm.documentgenerator.document.add
- Получить документ crm.documentgenerator.document.get
- Получить поля документа crm.documentgenerator.document.getfields
- Обновить документ crm.documentgenerator.document.update
- Удалить документ crm.documentgenerator.document.delete
- Как добавить шаблон и создать документ на его основе