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: documentgenerator

Who 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
type

Description

id*
integer

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 (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.template.getfields',
                {
                    id: 57
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.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);

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 `type`	Description
result `object`	Root element of the response (detailed description)
time `time`	Information about the request execution time

Object result

Name
type

Description

templateFields
object

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 `type`	Description
title `string`	Field name, may be absent
value `any`	Current value of the field
default `any`	Default value of the field
required `char`	Indicator of mandatory status. `Y` — mandatory `N` — optional
type `string`	Field type, for example `IMAGE`
group `array`	Groups to which the field belongs
chain `string` \| `array`	Path of the field in the data provider

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "Cannot get fields from deleted template"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
`400`	`100`	Bitrix\DocumentGenerator\Template constructor must be public	Required parameter `id` not provided
`400`	`0`	Template not found	Template with the specified `id` not found
`400`	`0`	Cannot get fields from deleted template	Cannot retrieve fields from a deleted template
`400`	`0`	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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	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
`500`	`PORTAL_DELETED` Portal was deleted	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

Delete Template

Overview of Methods

Get the List of Fields for documentgenerator.template.getfields

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object templateFieldObject templateField

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning