Get the List of Fields for documentgenerator.template.getfields
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:
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.documentgenerator.template.getfields(
bitrix_id=57,
).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.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);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "documentgenerator.template.getfields", b24.Params{
"id": 57,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("documentgenerator.template.getfields: %w", err)
}
// The method wraps the response in an object with the "templateFields" key.
raw, ok := b24.Unwrap(res.Result, "templateFields")
if !ok {
return fmt.Errorf("no templateFields key in the response")
}
fmt.Printf("%s\n", raw)
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 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
|
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: 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 |