Get a List of documentgenerator.template.list Templates

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 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 -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
        
// 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 TemplateItem = {
          id: string
          active: string
          name: string
          code: string
          region: string
          sort: string
          createTime: ISODate | null
          updateTime: ISODate | null
          createdBy: string
          updatedBy: string
          moduleId: string
          fileId: string
          bodyType: string
          numeratorId: string
          withStamps: string
          productsTableVariant: string
          isDeleted: string
          isDefault: string
          download: string
          downloadMachine: string
          users?: string[]
          providers?: string[]
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type TemplateListResult = {
          templates: Record<string, TemplateItem>
        }
        
        try {
          // documentgenerator.template.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<TemplateListResult>({
            method: 'documentgenerator.template.list',
            params: {
              select: ['*', 'users', 'providers'],
              order: {
                id: 'desc',
              },
              filter: {
                region: 'ru',
                active: 'Y',
                '>=createTime': '2026-03-18T00:00:00+03:00',
              },
              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('Templates count:', Object.keys(result.templates).length, result.templates)
          }
        } 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 listTemplates() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // documentgenerator.template.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.template.list',
                params: {
                  select: ['*', 'users', 'providers'],
                  order: {
                    id: 'desc',
                  },
                  filter: {
                    region: 'ru',
                    active: 'Y',
                    '>=createTime': '2026-03-18T00:00:00+03:00',
                  },
                  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('Templates count:', Object.keys(result.templates).length, result.templates)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listTemplates)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.documentgenerator.template.list(
                select=[
                    "*",
                    "users",
                    "providers",
                ],
                order={
                    "id": "desc",
                },
                filter={
                    "region": "ru",
                    "active": "Y",
                    ">=createTime": "2026-03-18T00:00:00+03:00",
                },
                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.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);
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "documentgenerator.template.list", b24.Params{
        	"select": []string{"*", "users", "providers"},
        	"order": b24.Params{
        		"id": "desc",
        	},
        	"filter": b24.Params{
        		"region":       "ru",
        		"active":       "Y",
        		">=createTime": "2026-03-18T00:00:00+03:00",
        	},
        	"start": 0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("documentgenerator.template.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": {
                "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 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 modify templates

Insufficient rights to retrieve the list of templates

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