Get a List of Document Templates crm.documentgenerator.template.list
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:
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>
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();
}
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
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.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
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.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
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}")
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>';
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 may consist of digits, Latin letters, and underscores |
|
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 |
|
|
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: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- 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