Get the List of Fields for documentgenerator.template.getfields
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:
documentgeneratorWho can execute the method: a user with permission to modify document generator templates
The method documentgenerator.template.getfields returns the detail form of the template fields.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the template. You can obtain the template identifier after creating a template or by using the method to get the list of templates |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":57}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.getfields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":57,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/documentgenerator.template.getfields
// 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 TemplateField = {
title?: string
value: unknown
default: unknown
required?: string
type?: string
group?: string[]
chain?: string | unknown[]
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type TemplateGetFieldsResult = {
templateFields: Record<string, TemplateField>
}
try {
const response = await $b24.actions.v2.call.make<TemplateGetFieldsResult>({
method: 'documentgenerator.template.getfields',
params: {
id: 57,
},
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(Object.keys(result.templateFields))
}
} 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 getTemplateFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'documentgenerator.template.getfields',
params: {
id: 57,
},
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(Object.keys(result.templateFields))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTemplateFields)
</script>
try {
$response = $b24Service->core->call(
'documentgenerator.template.getfields',
[
'id' => 57,
]
);
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'documentgenerator.template.getfields',
{
id: 57
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'documentgenerator.template.getfields',
[
'id' => 57,
]
);
print_r($result);
Response Handling
HTTP Status: 200
{
"result": {
"templateFields": {
"DocumentNumber": {
"title": "Number",
"value": "9",
"required": "Y",
"group": [
"Document"
],
"chain": "this.DOCUMENT.DOCUMENT_NUMBER",
"default": "9"
},
"CurrentDate": {
"value": "",
"default": ""
},
"ClientName": {
"value": "",
"default": ""
},
"ClientPhone": {
"value": "",
"default": ""
},
"Total": {
"value": "",
"default": ""
},
"Comment": {
"value": "",
"default": ""
},
"UserName": {
"value": "",
"default": ""
},
"DocumentTitle": {
"title": "Document Title",
"value": "SUPPLY_CONTRACT_NEW Template 1773843147554 9",
"group": [
"Document"
],
"chain": [
{},
"getTitle"
],
"required": "Y",
"default": "SUPPLY_CONTRACT_NEW Template 1773843147554 9"
}
}
},
"time": {
"start": 1774332782,
"finish": 1774332783.055467,
"duration": 1.055466890335083,
"processing": 1,
"date_start": "2026-03-24T09:13:02+01:00",
"date_finish": "2026-03-24T09:13:03+01:00",
"operating_reset_at": 1774333382,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
templateFields |
Object of template fields. Key — template field, value — field description (detailed description). The set of fields in the description depends on the field type |
Object templateField
|
Name |
Description |
|
title |
Field name, may be absent |
|
value |
Current value of the field |
|
default |
Default value of the field |
|
required |
Indicator of mandatory status.
|
|
type |
Field type, for example |
|
group |
Groups to which the field belongs |
|
Path of the field in the data provider |
Error Handling
HTTP Status: 400
{
"error": "0",
"error_description": "Cannot get fields from deleted template"
}
|
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
|
Status |
Code |
Description |
Value |
|
|
|
Bitrix\DocumentGenerator\Template constructor must be public |
Required parameter |
|
|
|
Template not found |
Template with the specified |
|
|
|
Cannot get fields from deleted template |
Cannot retrieve fields from a deleted template |
|
|
|
You do not have permissions to modify templates |
Insufficient permissions to work with templates |
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 |