Get a List of documentgenerator.template.list Templates

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

Who can execute the method: a user with permission to modify document generator templates

The method documentgenerator.template.list returns a list of templates based on the filter.

Method Parameters

Required parameters are marked with *

Name `type`	Description
select `array`	An array of fields to return. Default is `["*"]`. For `field_N`, use fields from the fields table. To retrieve access codes and providers, add the `users` and `providers` fields to `select`
order `object`	An object for sorting templates in the format `{"field_1":"value_1", ... "field_N":"value_N"}`. The 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 templates 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 `field_n` keys 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 `=%`) `=` — equal, exact match (used by default) `!=` — not equal `!` — not equal By default, the filter `isDeleted = "N"` is applied
start `integer`	This parameter is used to manage pagination. The page size for 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`	Template identifier
active `char`	Template activity. Possible values: `Y` — active `N` — inactive
name `string`	Template name
code `string`	Template symbolic code
region `string`	Template region
sort `integer`	Sort index
createTime `datetime`	Creation date and time
updateTime `datetime`	Update date and time
numeratorId `integer`	Identifier of the numerator
withStamps `char`	Use of stamps and signatures. Possible values: `Y` — yes `N` — no
users `array`	Access codes for the template. Only for `select`
providers `array`	Data providers for the template. Only for `select`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "select": [
              "*",
              "users",
              "providers"
            ],
            "order": {
              "id": "desc"
            },
            "filter": {
              "region": "de",
              "active": "Y",
              ">=createTime": "2026-03-18T00:00:00+01:00"
            },
            "start": 0
          }' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "select": [
              "*",
              "users",
              "providers"
            ],
            "order": {
              "id": "desc"
            },
            "filter": {
              "region": "de",
              "active": "Y",
              ">=createTime": "2026-03-18T00:00:00+01:00"
            },
            "start": 0,
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.template.list

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.template.list',
                {
                    select: ['*', 'users', 'providers'],
                    order: {
                        id: 'desc'
                    },
                    filter: {
                        region: 'de',
                        active: 'Y',
                        '>=createTime': '2026-03-18T00:00:00+01:00'
                    },
                    start: 0
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.template.list',
                [
                    'select' => ['*', 'users', 'providers'],
                    'order' => [
                        'id' => 'desc'
                    ],
                    'filter' => [
                        'region' => 'de',
                        'active' => 'Y',
                        '>=createTime' => '2026-03-18T00:00:00+01:00'
                    ],
                    'start' => 0,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.template.list',
            {
                select: ['*', 'users', 'providers'],
                order: {
                    id: 'desc'
                },
                filter: {
                    region: 'de',
                    active: 'Y',
                    '>=createTime': '2026-03-18T00:00:00+01:00'
                }
            },
            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.template.list',
            [
                'select' => ['*', 'users', 'providers'],
                'order' => [
                    'id' => 'desc'
                ],
                'filter' => [
                    'region' => 'de',
                    'active' => 'Y',
                    '>=createTime' => '2026-03-18T00:00:00+01:00'
                ],
                'start' => 0,
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "templates": {
                    "57": {
                        "id": "57",
                        "active": "Y",
                        "name": "SUPPLY_CONTRACT_NEW Template",
                        "code": "REST_TEMPLATE",
                        "region": "de",
                        "sort": "700",
                        "createTime": "2026-03-23T16:51:25+01:00",
                        "updateTime": "2026-03-23T17:26:39+01:00",
                        "createdBy": "503",
                        "updatedBy": "503",
                        "moduleId": "rest",
                        "fileId": "5641",
                        "bodyType": "Bitrix\\DocumentGenerator\\Body\\Docx",
                        "numeratorId": "3",
                        "withStamps": "N",
                        "productsTableVariant": "",
                        "isDeleted": "N",
                        "isDefault": "N",
                        "download": "/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=57",
                        "providers": [
                            "bitrix\\documentgenerator\\dataprovider\\rest"
                        ],
                        "users": [
                            "U503"
                        ],
                        "downloadMachine": "https://mysite.com/rest/documentgenerator.api.template.download.json?auth=3f5cc2690000071b00000844000001f7f0f107506cefda4aa5b9d0dc80371e7f0f7e26&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZTSVRFX0lEPXMxJmlkPTU3Jl89RFB3MHZYN1A3RXdiMm5EenY2VFYyc1Vkb0hPejA3SlM%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzUwWlcxd2JHRjBaUzVrYjNkdWJHOWhaQ1pUU1ZSRlgwbEVQWE14Sm1sa1BUVTNKbDg5UkZCM01IWllOMUEzUlhkaU1tNUVlblkyVkZZeWMxVmtiMGhQZWpBM1NsTT18M2Y1Y2MyNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDc1MDZjZWZkYTRhYTViOWQwZGM4MDM3MWU3ZjBmN2UyNiI%3D.XuC83kQJE21vRoqv1%2FgdT8OiYq4JdpiSLxumy%2F1UcB0%3D"
                    },
                    "53": {
                        "id": "53", // description of the next template
                        ...
                    },
                    "51": {
                        "id": "51", // description of the next template
                        ...
                    }
                }
            },
            "total": 3,
            "time": {
                "start": 1774341679,
                "finish": 1774341679.641056,
                "duration": 0.6410560607910156,
                "processing": 0,
                "date_start": "2026-03-24T11:41:19+01:00",
                "date_finish": "2026-03-24T11:41:19+01:00",
                "operating_reset_at": 1774342279,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response (detailed description)
total `integer`	Total number of templates in the list
time `time`	Information about the execution time of the request

Result Object

Name `type`	Description
templates `object`	Object of templates, where the key is `id`, and the value is the template data (detailed description)

Template Object Element

Name `type`	Description
id `string`	Template identifier
active `char`	Template activity. Possible values: `Y` — active `N` — inactive
name `string`	Template name
code `string`	Template symbolic code
region `string`	Template region
sort `string`	Sort index
createTime `datetime`	Creation date and time
updateTime `datetime`	Update date and time
createdBy `string`	Identifier of the user who created the template
updatedBy `string`	Identifier of the user who updated the template
moduleId `string`	Module identifier
fileId `string`	Template file identifier
bodyType `string`	Class of the template body type
numeratorId `string`	Identifier of the numerator
withStamps `char`	Use of stamps and signatures. Possible values: `Y` — yes `N` — no
productsTableVariant `string`	Variant of the products table
isDeleted `char`	Deletion flag of the template. Possible values: `Y` — deleted `N` — not deleted
isDefault `char`	Default template flag. Possible values: `Y` — yes `N` — no
download `string`	Link to download the template
downloadMachine `string`	Link to download the template for machine processing
users `array`	Array of access codes if the field is selected in `select`
providers `array`	Array of providers if the field is selected in `select`

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "You do not have permissions to modify templates"
        }

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

Status	Code	Description	Value
`400`	`0`	You do not have permissions to modify templates	Insufficient rights to retrieve the list of templates

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

Get Template by ID

Delete Template

Get a List of documentgenerator.template.list Templates

Method ParametersMethod Parameters

Fields for select, order, filterFields for select, order, filter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Template Object ElementTemplate Object Element

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning