Get a List of Documents crm.documentgenerator.document.list
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
crmWho can execute the method: a user with "view" access permission for document generator documents
The method crm.documentgenerator.document.list returns a list of documents based on the filter.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select |
A list of fields that should be populated in the documents returned. You can use:
Refer to the Document Type section for the list of fields. By default, |
|
filter |
An object in the following format:
where:
You can add prefixes to the keys
Refer to the Document Type section for the list of available fields for filtering. |
|
order |
An object in the following format:
where:
Refer to the Document Type section for the list of fields for sorting. Example: |
|
start |
Pagination parameter. The page size is fixed: The formula for obtaining the N-th page: For more details, refer to the article Features of List Methods |
Code Examples
How to Use Examples in Documentation
Example of retrieving a list of documents where:
- fields
id,title,number,entityId,createTimeare selected - sorted by
idin descending order - filtered by
entityTypeId = 2andentityId = 101 - starting offset —
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 Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
as_list Example
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 Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
as_list_fast Example
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 Error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK Error: {error.message}")
except Exception as error:
print(f"Unexpected error: {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>';
Response Handling
HTTP status: 200
{
"result": {
"documents": [
{
"id": "61",
"title": "Demonstration implementation of product 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.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.download&SITE_ID=s1&id=61",
"pdfUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getPdf&SITE_ID=s1&id=61",
"imageUrl": "https://bitrix.bitrix24.com/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.com/rest/crm.documentgenerator.document.download.json?auth=***&token=***",
"pdfUrlMachine": "https://bitrix.bitrix24.com/rest/crm.documentgenerator.document.getPdf.json?auth=***&token=***",
"imageUrlMachine": "https://bitrix.bitrix24.com/rest/crm.documentgenerator.document.getImage.json?auth=***&token=***"
},
{
"id": "59",
"title": "Demonstration implementation of product 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.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.download&SITE_ID=s1&id=59",
"pdfUrl": "https://bitrix.bitrix24.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.document.getPdf&SITE_ID=s1&id=59",
"imageUrl": "https://bitrix.bitrix24.com/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.com/rest/crm.documentgenerator.document.download.json?auth=***&token=***",
"pdfUrlMachine": "https://bitrix.bitrix24.com/rest/crm.documentgenerator.document.getPdf.json?auth=***&token=***",
"imageUrlMachine": "https://bitrix.bitrix24.com/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
}
}
Returned Data
|
Name |
Description |
|
result |
Root object of the response. Contains the structure |
|
total |
The total number of documents matching the filter |
|
next |
Offset for the next page. Returned if there is a next page |
|
time |
Information about the request execution time |
Result Type
|
Name |
Description |
|
documents |
An array of documents. The structure of each element is described in the |
Document Type
The composition of fields depends on the select parameter.
|
Name |
Description |
|
id |
Document identifier |
|
title |
Document name |
|
number |
Document number |
|
Identifier of the document template |
|
|
Identifier of the CRM object type |
|
|
Identifier of the CRM object |
|
|
Document DOCX file identifier |
|
|
Document image identifier |
|
|
Document PDF file identifier |
|
|
createTime |
Date of document creation |
|
updateTime |
Document update date |
|
Identifier of the user who created the document |
|
|
Identifier of the user who updated the document |
|
|
Field values of the document |
|
|
downloadUrl |
Link to download the document |
|
imageUrl |
Link to the document image |
|
pdfUrl |
Link to the PDF document |
|
downloadUrlMachine |
Link to download the document for machine access |
|
pdfUrlMachine |
Link to the PDF document for machine access |
|
imageUrlMachine |
Link to the document image for machine access |
|
stampsEnabled |
Stamp and signature inclusion flag |
Error Handling
HTTP status: 400
{
"error": "ACCESS_DENIED",
"error_description": "Access denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Unknown field definition ENTITY_TYPE_ID (ENTITY_TYPE_ID) for \Bitrix\DocumentGenerator\Model\Document Entity |
The |
|
|
Access denied |
Insufficient permissions to read documents based on the selected CRM object filter |
|
Empty value |
You do not have permissions to view documents |
Insufficient permissions to view document generator documents |
|
Empty value |
Module documentgenerator is not installed |
The |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create a New Document crm.documentgenerator.document.add
- Get Document crm.documentgenerator.document.get
- Get Document Fields crm.documentgenerator.document.getfields
- Update Document crm.documentgenerator.document.update
- Delete Document crm.documentgenerator.document.delete
- How to Add a Template and Create a Document Based on It