Get the List of Documents documentgenerator.document.list

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: documentgenerator

Who can execute the method: a user with permission to view documents

The method documentgenerator.document.list returns a list of documents based on the filter.

Method Parameters

Required parameters are marked with *

Name
type

Description

select
array

An array containing the list of fields to return.

Defaults to ["*"]

order
object

An object for sorting documents in the format {"field_1":"value_1", ... "field_N":"value_N"}.

Sorting direction can take the following values:

  • asc — ascending
  • desc — descending

For field_N, use fields from the fields table.

filter
object

An object for filtering documents in the format {"field_1":"value_1", ... "field_N":"value_N"}.

For field_N, use fields from the fields table.

You can add a prefix to the keys field_n to specify the filter operation.
Possible prefix values:

  • >= — 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
  • % — LIKE, substring search. The % symbol should not be included in the filter value. The search looks for the substring in any position of the string
  • =% — LIKE, substring search. The % symbol must be included in the value. Examples:
    • "mol%" — searches for values starting with "mol"
    • "%mol" — searches for values ending with "mol"
    • "%mol%" — searches for values where "mol" can be in any position
  • %= — LIKE (similar to =%)
  • = — equals, exact match (used by default)
  • != — not equal
  • ! — not equal

start
integer

This parameter is used for pagination control.

The page size of results is always static — 50 records.

To select the second page of results, you need to pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N — 1) * 50, where N is the desired page number

Fields for select, order, filter

Name
type

Description

id
integer

Document identifier

title
string

Document title

number
string

Document number

templateId
integer

Template identifier

provider
string

Provider class

value
string

External identifier of the object

fileId
integer

Identifier of the document's DOCX file

imageId
integer

Identifier of the document's image file

pdfId
integer

Identifier of the document's PDF file

createTime
datetime

Document creation time

updateTime
datetime

Document update time

values
object

Document field values

createdBy
integer

Identifier of the user who created the document

updatedBy
integer

Identifier of the user who updated the document

Code Examples

How to Use Examples in Documentation

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+01:00",
              "%title": "DG-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+01:00",
              "%title": "DG-2026"
            },
            "start": 0,
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/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
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type DocumentListResult = {
          documents: {
            id: string
            title: string
            number: string
            templateId: string
            provider: string
            value: string
            fileId: number
            imageId: number
            pdfId: number
            createTime: ISODate | null
            updateTime: ISODate | null
            createdBy: string
            updatedBy: number
            downloadUrl: string
            pdfUrl: string
            imageUrl: string
            stampsEnabled: boolean
            downloadUrlMachine: string
            pdfUrlMachine: string
            imageUrlMachine: string
            values: object | null
          }[]
        }
        
        try {
          // 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: 'documentgenerator.document.list',
            params: {
              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': 'DG-2026',
              },
              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 page:', result.documents.length)
            console.info('Documents:', 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()
        
              // 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: 'documentgenerator.document.list',
                params: {
                  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': 'DG-2026',
                  },
                  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 page:', result.documents.length)
              console.info('Documents:', result.documents)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchDocumentList)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.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": "DG-2026",
                },
                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}")
        
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+01:00',
                        '%title' => 'DG-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+01:00',
                    '%title': 'DG-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+01:00',
                    '%title' => 'DG-2026',
                ],
                'start' => 0,
            ]
        );
        
        print_r($result);
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "documentgenerator.document.list", b24.Params{
        	"select": []string{"id", "title", "number", "templateId", "provider", "value", "fileId", "imageId", "pdfId", "createTime", "updateTime", "createdBy"},
        	"order": b24.Params{
        		"updateTime": "desc",
        		"id":         "desc",
        	},
        	"filter": b24.Params{
        		">=createTime": "2026-03-18T00:00:00+03:00",
        		"%title":       "DG-2026",
        	},
        	"start": 0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("documentgenerator.document.list: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "documents": [
                    {
                        "id": "51",
                        "title": "SUPPLY_CONTRACT Template 1773843147554 DG-2026-001",
                        "number": "DG-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+01:00",
                        "updateTime": "2026-03-18T17:27:48+01:00",
                        "createdBy": "503",
                        "downloadUrl": "https://mysite.com/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&SITE_ID=s1&id=51",
                        "pdfUrl": "https://mysite.com/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getpdf&SITE_ID=s1&id=51",
                        "imageUrl": "https://mysite.com/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getimage&SITE_ID=s1&id=51",
                        "values": null,
                        "stampsEnabled": false,
                        "downloadUrlMachine": "https://mysite.com/rest/documentgenerator.api.document.getfile.json?auth=63bfbb690000071b00000844000001f7f0f107a3f045d88e8327666879f4b04885d7af&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlJlNJVEVfSUQ9czEmaWQ9NTEmXz1WMXA5WU1YMkRSbUJraDA1cmhjVVRIZXFkRE5EWmpLcA%3D%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRmaWxlfGRvY3VtZW50Z2VuZXJhdG9yfFlXTjBhVzl1UFdSdlkzVnRaVzUwWjJWdVpYSmhkRzl5TG1Gd2FTNWtiMk4xYldWdWRDNW5aWFJtYVd4bEpsTkpWRVZmU1VROWN6RW1hV1E5TlRFbVh6MVdNWEE1V1UxWU1rUlNiVUpyYURBMWNtaGpWVlJJWlhGa1JFNUVXbXBMY0E9PXw2M2JmYmI2OTAwMDAwNzFiMDAwMDA4NDQwMDAwMDFmN2YwZjEwN2EzZjA0NWQ4OGU4MzI3NjY2ODc5ZjRiMDQ4ODVkN2FmIg%3D%3D.b2USzpTXZIDIUEgZjOXB4hDphKJjQY5spzTOdimZvss%3D",
                        "pdfUrlMachine": "https://mysite.com/rest/documentgenerator.api.document.getpdf.json?auth=63bfbb690000071b00000844000001f7f0f107a3f045d88e8327666879f4b04885d7af&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRwZGYmU0lURV9JRD1zMSZpZD01MSZfPUgyc0IwUlpMa1BueVpvV29rajVHUnFHUWU1T0cwQ2Z1%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRwZGZ8ZG9jdW1lbnRnZW5lcmF0b3J8WVdOMGFXOXVQV1J2WTNWdFpXNTBaMlZ1WlhKaGRHOXlMbUZ3YVM1a2IyTjFiV1Z1ZEM1blpYUndaR1ltVTBsVVJWOUpSRDF6TVNacFpEMDFNU1pmUFVneWMwSXdVbHBNYTFCdWVWcHZWMjlyYWpWSFVuRkhVV1UxVDBjd1EyWjF8NjNiZmJiNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDdhM2YwNDVkODhlODMyNzY2Njg3OWY0YjA0ODg1ZDdhZiI%3D.m0Ng5a%2BitODVrxQonwPkRt9L8dr2Jx9fbxnY%2BoZzAe4%3D",
                        "imageUrlMachine": "https://mysite.com/rest/documentgenerator.api.document.getimage.json?auth=63bfbb690000071b00000844000001f7f0f107a3f045d88e8327666879f4b04885d7af&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRpbWFnZSZTSVRFX0lEPXMxJmlkPTUxJl89RGJHM3pFUTlPTmhYNVlrWUc3NEx6MTVUYUdzdlVkUGk%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS5kb2N1bWVudC5nZXRpbWFnZXxkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzVrYjJOMWJXVnVkQzVuWlhScGJXRm5aU1pUU1ZSRlgwbEVQWE14Sm1sa1BUVXhKbDg5UkdKSE0zcEZVVGxQVG1oWU5WbHJXVWMzTkV4Nk1UVlVZVWR6ZGxWa1VHaz18NjNiZmJiNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDdhM2YwNDVkODhlODMyNzY2Njg3OWY0YjA0ODg1ZDdhZiI%3D.40ZdIhNinEEmMsb%2FQm%2BCseG%2BKe0ZmR6vpQhs6N6KjfQ%3D"
                    },
                    {
                        "id": "37",
                        ... // document description with id=37
                    },
                    {
                        "id": "33",
                        ... // document description with id=33
                    }
                ]
            },
            "total": 3,
            "time": {
                "start": 1773908326,
                "finish": 1773908326.204212,
                "duration": 0.20421195030212402,
                "processing": 0,
                "date_start": "2026-03-19T11:18:46+01:00",
                "date_finish": "2026-03-19T11:18:46+01:00",
                "operating_reset_at": 1773908926,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response (detailed description)

total
integer

Total number of elements based on the filter

time
time

Information about the request execution time

Result Object

Name
type

Description

documents
array

List of documents.

The structure of fields depends on select

Document Array Element

Name
type

Description

id
string

Document identifier

title
string

Document title

number
string

Document number

templateId
string

Template identifier

provider
string

Data provider class

value
string

External identifier of the object

fileId
integer

Identifier of the document's DOCX file

imageId
integer

Identifier of the document's image file

pdfId
integer

Identifier of the document's PDF file

createTime
datetime

Document creation time

updateTime
datetime

Last update time of the document

values
object

Document field values (detailed description)

createdBy
string

Identifier of the user who created the document

updatedBy
integer

Identifier of the user who updated the document

downloadUrl
string

Link to download the DOCX for the user

pdfUrl
string

Link to download the PDF for the user

imageUrl
string

Link to download the image for the user

stampsEnabled
boolean

Indicator of enabled stamps and signatures

downloadUrlMachine
string

Link to download the DOCX for the application

pdfUrlMachine
string

Link to download the PDF for the application

imageUrlMachine
string

Link to download the image for the application

Values Object

Name
type

Description

_creationMethod
string

Method of document creation

stampsEnabled
boolean

Indicator of enabled stamps and signatures

<field_code>
string

Value of the field from the template by its code

Error Handling

HTTP Status: 400

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

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

0

You do not have permissions to view documents

Insufficient rights to view the list of documents

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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