Get the list of document templates crm.documentgenerator.template.list

Scope: crm

Who can execute the method: user with "edit" access permission for document generator templates

The method crm.documentgenerator.template.list returns a list of document templates.

Method Parameters

Required parameters are marked with *

Name
type

Description

select
array

List of fields to return for the templates.

You can use:

  • '*' — to select all standard fields of the template
  • an explicit list of fields, for example ["id","name","region","active"]

Additionally, the following are supported:

  • entityTypeId — array of template bindings to CRM entities
  • users — array of access permission codes

Main fields for select: id, name, region, code, active, moduleId, numeratorId, withStamps, isDeleted, sort, createTime, updateTime

See the list of template fields in the section Type template. By default, ["*"] is used.

filter
object

Object format:

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

where:

  • field_n — name of the field for filtering
  • value_n — 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

Features:

  • if isDeleted is not provided, the filter isDeleted = "N" is applied
  • the filter moduleId is forcibly limited to the value crm
  • you can filter by entityTypeId, for example ["2","2_category_37"]

Main fields for filter: id, name, region, code, active, moduleId, numeratorId, withStamps, isDeleted, sort, createTime, updateTime, entityTypeId

order
object

Object format:

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

where:

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

Main fields for order: id, name, region, code, active, moduleId, numeratorId, withStamps, isDeleted, sort, createTime, updateTime

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

start
integer

Pagination parameter.

The page size is fixed: 50 records.

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

More details in the article Features of list methods

Code Examples

How to Use Examples in Documentation

Example of obtaining a list of templates where:

  • fields id, name, region, entityTypeId, users are selected
  • sorting by id in descending order
  • filter by region de and activity Y
  • starting offset — 0
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","name","region","entityTypeId","users"],"order":{"id":"desc"},"filter":{"region":"de","active":"Y"},"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.template.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","name","region","entityTypeId","users"],"order":{"id":"desc"},"filter":{"region":"de","active":"Y"},"start":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.template.list
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.template.list',
        		{
        			select: ['id', 'name', 'region', 'entityTypeId', 'users'],
        			order: { id: 'desc' },
        			filter: { region: 'de', active: 'Y' },
        			start: 0,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.template.list',
                    [
                        'select' => ['id', 'name', 'region', 'entityTypeId', 'users'],
                        'order' => ['id' => 'desc'],
                        'filter' => ['region' => 'de', 'active' => 'Y'],
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting templates list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.documentgenerator.template.list',
            {
                select: ['id', 'name', 'region', 'entityTypeId', 'users'],
                order: { id: 'desc' },
                filter: { region: 'de', active: 'Y' },
                start: 0,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.template.list',
            [
                'select' => ['id', 'name', 'region', 'entityTypeId', 'users'],
                'order' => ['id' => 'desc'],
                'filter' => ['region': 'de', 'active': 'Y'],
                'start' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "templates": {
                    "39": {
                        "id": "39",
                        "name": "Demonstration of product implementation",
                        "region": "de",
                        "download": "https://mysite.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.template.download&SITE_ID=s1&id=39",
                        "users": [
                            "UA"
                        ],
                        "entityTypeId": [
                            "2_category_0",
                            "2_category_32"
                        ],
                        "downloadMachine": "https://mysite.com/rest/crm.documentgenerator.template.download.json?auth=***&token=***"
                    },
                    "37": {
                        "id": "37",
                        "name": "Act of write-off of products (Germany)",
                        "region": "de",
                        "download": "https://mysite.com/bitrix/services/main/ajax.php?action=crm.documentgenerator.template.download&SITE_ID=s1&id=37",
                        "users": [
                            "UA"
                        ],
                        "entityTypeId": [
                            "2_category_37",
                            "bitrix\\crm\\integration\\documentgenerator\\dataprovider\\storedocumentdeduct"
                        ],
                        "downloadMachine": "https://mysite.com/rest/crm.documentgenerator.template.download.json?auth=***&token=***"
                    }
                }
            },
            "total": 20,
            "time": {
                "start": 1773845479,
                "finish": 1773845479.829607,
                "duration": 0.8296070098876953,
                "processing": 0,
                "date_start": "2026-03-18T17:51:19+02:00",
                "date_finish": "2026-03-18T17:51:19+02:00",
                "operating_reset_at": 1773846079,
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response. Contains the object templates

total
integer

Total number of templates matching the filter

time
time

Information about the execution time of the request

Object templates

object, where the key is the string identifier of the template, and the value is the object template

Type template

Name
type

Description

id
string

Identifier of the template

name
string

Name of the template

region
string

Region of the template

download
string

Link to download the template

users
array

Array of user or access group codes

entityTypeId
array

Array of bindings to object types

downloadMachine
string

Link for machine download of the template

code
string

Symbolic code of the template. Can be null

active
char

Activity status (Y/N)

moduleId
string

Identifier of the module owning the template

numeratorId
integer

Identifier of the numerator

withStamps
char

Indicator of stamp usage (Y/N)

isDeleted
char

Indicator of deletion (Y/N)

sort
integer

Sorting index

createTime
datetime

Time of template creation

updateTime
datetime

Time of last template update

Error Handling

HTTP status: 400

{
            "error": "DOCGEN_ACCESS_ERROR",
            "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

DOCGEN_ACCESS_ERROR

Access denied

No access to templates

Empty value

You do not have permissions to modify templates

Insufficient rights to modify document generator templates

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 allowed to be called 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 methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users

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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Previous
Get Document Template Information by Id
Next
Delete Document Template