Get a List of Document Templates crm.documentgenerator.template.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:
crmWho can execute the method: a user with "modify" 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 |
Description |
|
select |
A list of fields to return for the templates. You can use:
Additionally, the following are supported:
Main fields for See the list of template fields in the Type template section. By default, |
|
filter |
An object in the format:
where:
You can add prefixes to the keys
Features:
Main fields for |
|
order |
An object in the format:
where:
Main fields for Example: |
|
start |
Pagination parameter. The page size is fixed: The formula for obtaining the N-th page: 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 templates where:
- fields
id,name,region,entityTypeId,usersare selected - sorted by
idin descending order - filtering by region
ruand activityY - 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
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type Template = {
id: string
name: string
region: string
download: string
users: string[]
entityTypeId: string[]
downloadMachine: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type TemplatesResult = {
templates: Record<string, Template>
}
try {
// crm.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<TemplatesResult>({
method: 'crm.documentgenerator.template.list',
params: {
select: ['id', 'name', 'region', 'entityTypeId', 'users'],
order: { id: 'desc' },
filter: { region: 'de', active: 'Y' },
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 on this page:', Object.keys(result.templates).length)
console.info(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 fetchTemplateList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// crm.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: 'crm.documentgenerator.template.list',
params: {
select: ['id', 'name', 'region', 'entityTypeId', 'users'],
order: { id: 'desc' },
filter: { region: 'de', active: 'Y' },
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 on this page:', Object.keys(result.templates).length)
console.info(result.templates)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchTemplateList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.template.list(
select=["id", "name", "region", "entityTypeId", "users"],
order={"id": "desc"},
filter={
"region": "de",
"active": "Y",
},
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}")
as_list Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.template.list(
select=["id", "name", "region", "entityTypeId", "users"],
order={"id": "desc"},
filter={
"region": "de",
"active": "Y",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
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}")
as_list_fast Example
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.template.list(
select=["id", "name", "region", "entityTypeId", "users"],
order={"id": "desc"},
filter={
"region": "de",
"active": "Y",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
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(
'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' },
},
(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.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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.documentgenerator.template.list", b24.Params{
"select": []string{"id", "name", "region", "entityTypeId", "users"},
"order": b24.Params{
"id": "desc",
},
"filter": b24.Params{
"region": "ru",
"active": "Y",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.documentgenerator.template.list: %w", err)
}
// The method wraps the response in an object with the "templates" key.
raw, ok := b24.Unwrap(res.Result, "templates")
if !ok {
return fmt.Errorf("no templates key in the response")
}
fmt.Printf("%s\n", raw)
Response Handling
HTTP status: 200
{
"result": {
"templates": {
"39": {
"id": "39",
"name": "Product demonstration 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": "Inventory Write-off Report (United States)",
"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+03:00",
"date_finish": "2026-03-18T17:51:19+03:00",
"operating_reset_at": 1773846079,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response. Contains the object |
|
total |
The total number of templates matching the filter |
|
time |
Information about the request execution time |
Templates Object
object, where the key is the string identifier of the template, and the value is the object template
Template Type
|
Name |
Description |
|
id |
Identifier of the template |
|
name |
Template name |
|
region |
Template region |
|
download |
The link to download the template |
|
users |
An array of user or access group codes |
|
entityTypeId |
An array of bindings to object types |
|
downloadMachine |
The link for machine downloading of the template |
|
code |
The symbolic code of the template. Can be |
|
active |
The activity status ( |
|
moduleId |
The identifier of the template owner module |
|
numeratorId |
The identifier of the numerator |
|
withStamps |
The indication of stamp usage ( |
|
isDeleted |
The indication of deletion ( |
|
sort |
Sorting index |
|
createTime |
The creation time of the template |
|
updateTime |
The last update time of the template |
Error Handling
HTTP status: 400
{
"error": "DOCGEN_ACCESS_ERROR",
"error_description": "Access denied"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Access denied |
No access to templates |
|
Empty value |
You do not have permissions to modify templates |
Insufficient permissions to modify document generator templates |
|
Empty value |
Module documentgenerator is not installed |
The |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Add a New Template crm.documentgenerator.template.add
- Update Existing Document Template crm.documentgenerator.template.update
- Get Information About Document Template by Id crm.documentgenerator.template.get
- Delete Document Template crm.documentgenerator.template.delete
- Get Document Template Fields crm.documentgenerator.template.getfields
- How to Add a Template and Create a Document Based on It