Get the List of Regions documentgenerator.region.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: documentgenerator

Who can execute the method: a user with permission to modify document generator templates

The method documentgenerator.region.list returns a list of pre-installed and custom regions.

Method Parameters

No parameters.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Accept: application/json" \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.region.list

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.region.list

try
        {
            const response = await $b24.callMethod('documentgenerator.region.list');
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call('documentgenerator.region.list');
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.region.list',
            {},
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call('documentgenerator.region.list');
        
        print_r($result);

Response Handling

HTTP Status: 200

The response may contain two types of elements:

A pre-installed region, which typically has code, title, languageId
A custom region, which may additionally have id, formatDate, formatDatetime, formatName

{
            "result": {
                "regions": {
                    "de": {
                        "code": "de",
                        "title": "Germany",
                        "languageId": "de"
                    },
                    "uk": {
                        "code": "uk",
                        "title": "United Kingdom",
                        "languageId": "en"
                    },
                    "br": {
                        "code": "br",
                        "title": "Brazil",
                        "languageId": "br"
                    },
                    "sp": {
                        "code": "sp",
                        "title": "Spain",
                        "languageId": "la"
                    },
                    "mx": {
                        "code": "mx",
                        "title": "Mexico",
                        "languageId": "la"
                    },
                    "pl": {
                        "code": "pl",
                        "title": "Poland",
                        "languageId": "pl"
                    },
                    "fr": {
                        "code": "fr",
                        "title": "France",
                        "languageId": "fr"
                    },
                    "1": {
                        "id": "1",
                        "title": "Germany (Custom)",
                        "languageId": "de",
                        "formatDate": "DD.MM.YYYY",
                        "formatDatetime": "DD.MM.YYYY HH:MI:SS",
                        "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
                        "code": "1"
                    }
                }
            },
            "time": {
                "start": 1774431603,
                "finish": 1774431603.769177,
                "duration": 0.7691769599914551,
                "processing": 0,
                "date_start": "2026-03-25T12:40:03+01:00",
                "date_finish": "2026-03-25T12:40:03+01:00",
                "operating_reset_at": 1774432203,
                "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
regions `object`	List of regions, where the object's key is the `code` of the region (detailed description)

Object regions

The regions object can contain both pre-installed and custom regions.

For a pre-installed region, the fields code, title, languageId are usually available
For a custom region, additional fields id, formatDate, formatDatetime, formatName may be returned

Name `type`	Description
id `string`	Identifier of the custom region; this field may be absent for a pre-installed region
code `string`	Code of the region
title `string`	Name of the region
languageId `string`	Language identifier of the region
formatDate `string`	Date format for the custom region
formatDatetime `string`	Date and time format for the custom region
formatName `string`	Full name template for the custom region

Error Handling

HTTP Status: 400

{
            "error": "0",
            "error_description": "You do not have permissions to modify templates"
        }

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`	`0`	You do not have permissions to modify templates	Insufficient permissions to modify document generator 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

Get Region by ID

Delete Region

Get the List of Regions documentgenerator.region.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object regionsObject regions

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning