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: crm

Who 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
type

Description

select
string[]

A list of fields that should be populated in the documents returned.

You can use:

  • '*' — to select all standard fields of the document
  • an explicit list of fields, for example, ['id','title','number','entityId','createTime']

Refer to the Document Type section for the list of fields.

By default, ['*'] is used.

filter
object

An object in the following format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n
        }

where:

  • field_n — the name of the field for filtering
  • value_n — the filter value

You can add prefixes to the keys field_n:

  • >= — greater than or equal to
  • > — greater than
  • <= — less than or equal to
  • < — less than
  • @ — IN, an array is passed as the value
  • !@ — NOT IN, an array is passed as the value
  • = — equal (default)
  • != or ! — not equal

Refer to the Document Type section for the list of available fields for filtering.

order
object

An object in the following format:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n
        }

where:

  • field_n — the name of the sorting field
  • value_n — the sorting direction: ASC or DESC

Refer to the Document Type section for the list of fields for sorting.

Example: {"id":"DESC","createTime":"ASC"}

start
integer

Pagination parameter.

The page size is fixed: 50 records.

The formula for obtaining the N-th page:
start = (N - 1) * 50

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, createTime are selected
  • sorted by id in descending order
  • filtered by entityTypeId = 2 and entityId = 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
        
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 },
            },
            (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": "Demo Product Implementation 2026-001",
                        "number": "2026-002",
                        "templateId": "39",
                        "fileId": "283",
                        "imageId": "285",
                        "pdfId": "287",
                        "createTime": "2026-03-20T13:51:45+02:00",
                        "updateTime": "2026-03-20T14:42:38+02: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": "Demo Product Implementation 2026-001",
                        "number": "2026-001",
                        "templateId": "39",
                        "fileId": "271",
                        "imageId": "273",
                        "pdfId": "275",
                        "createTime": "2026-03-20T13:28:26+02:00",
                        "updateTime": "2026-03-20T13:28:26+02: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+02:00",
                "date_finish": "2026-03-20T15:23:34+02:00",
                "operating_reset_at": 1774010014,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

The root object of the response. Contains the structure of result

total
integer

The total number of documents matching the filter

next
integer

Offset for the next page. Returned if there is a next page

time
time

Information about the execution time of the request

Result Type

Name
type

Description

documents
object[]

An array of documents. The structure of each element is described in the document type

Document Type

The composition of fields depends on the select parameter.

Name
type

Description

id
string

Document identifier

title
string

Document title

number
string

Document number

templateId
integer | string

Document template identifier

entityTypeId
integer | string

CRM object type identifier

entityId
integer | string

CRM object identifier

fileId
integer | string

Document DOCX file identifier

imageId
integer | string

Document image identifier

pdfId
integer | string

Document PDF file identifier

createTime
datetime

Document creation date

updateTime
datetime

Document update date

createdBy
integer | string | null

Identifier of the user who created the document

updatedBy
integer | string | null

Identifier of the user who updated the document

values
object | null

Document field values

downloadUrl
string

Link to download the document

imageUrl
string

Link to the document image

pdfUrl
string

Link to the PDF document

downloadUrlMachine
string

Link to download the document for machine access

pdfUrlMachine
string

Link to the PDF document for machine access

imageUrlMachine
string

Link to the document image for machine access

stampsEnabled
boolean

Indicates whether stamps and signatures can be applied

Error Handling

HTTP Status: 400

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

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
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

100

Unknown field definition ENTITY_TYPE_ID (ENTITY_TYPE_ID) for \Bitrix\DocumentGenerator\Model\Document Entity

The entityTypeId field passed in the select parameter is not a direct field of the document model. Use select: ['*']

ACCESS_DENIED

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 documentgenerator module is unavailable

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not permitted for calls using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The HTTPS protocol is required for method calls

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is only available on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user associated with the access token or webhook used to call the method lacks the necessary permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires higher privileges than those provided by the webhook token

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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

Previous
Retrieve Document Information by Id
Next
Delete Document