Get the List of Numerators crm.documentgenerator.numerator.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: crm

Who can execute the method: a user with "modify" access permission for document generator templates

The method crm.documentgenerator.numerator.list returns a list of numerators.

Method Parameters

Name `type`	Description
start `integer`	Offset for pagination. More details in the article Features of List Methods

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 '{"start":0}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.numerator.list

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

try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.numerator.list',
        		{
        			start: 0,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.numerator.list',
                    [
                        'start' => 0,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting numerators list: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.documentgenerator.numerator.list',
            {},
            (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.numerator.list',
            [
                'start' => 0,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": {
                "numerators": [
                    {
                        "id": "2",
                        "name": "Act (USA)",
                        "template": "{NUMBER}",
                        "settings": {
                            "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                                "start": 1,
                                "step": 1,
                                "periodicBy": null,
                                "timezone": null,
                                "isDirectNumeration": false
                            }
                        }
                    },
                    {
                        "id": "45",
                        "name": "REST Numerator (updated)",
                        "template": "INV-{NUMBER}",
                        "settings": {
                            "Bitrix_Main_Numerator_Generator_SequentNumberGenerator": {
                                "start": 100,
                                "step": 1,
                                "length": 0,
                                "padString": "0",
                                "periodicBy": null,
                                "timezone": null,
                                "isDirectNumeration": false
                            }
                        }
                    }
                ]
            },
            "total": 19,
            "time": {
                "start": 1773750210,
                "finish": 1773750210.283658,
                "duration": 0.2836580276489258,
                "processing": 0,
                "date_start": "2026-03-17T15:23:30+01:00",
                "date_finish": "2026-03-17T15:23:30+01:00",
                "operating_reset_at": 1773750810,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response. Contains an array of `numerators`
total `integer`	Total number of numerators
time `time`	Information about the execution time of the request

Array of numerators

Name `type`	Description
id `string`	Identifier of the numerator
name `string`	Name of the numerator
template `string`	Number template
settings `object`	Saved settings for sequential numbering of type `settings`

Type settings

Name `type`	Description
start `integer`	Initial value of the counter
step `integer`	Increment step of the counter
length `integer`	Minimum length of the number
padString `string`	Padding character on the left
periodicBy `string`	Period for resetting the counter: `null`, `day`, `month`, or `year`
timezone `string`	Time zone identifier for periodic reset. Can be `null`
isDirectNumeration `boolean`	Indicator of direct numbering

Error Handling

HTTP Status: 400

{
            "error": "",
            "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

Code	Description	Value
`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 `documentgenerator` module is unavailable

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 information about a numberer by Id

Delete a numberer

Get the List of Numerators crm.documentgenerator.numerator.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Array of numeratorsArray of numerators

Type settingsType settings

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning