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

// 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 NumeratorItem = {
          id: string
          name: string
          template: string
          code: string | null
          settings: {
            Bitrix_Main_Numerator_Generator_SequentNumberGenerator?: {
              start: number
              step: number
              length: number
              padString: string
              periodicBy: string | null
              timezone: string | null
              isDirectNumeration: boolean
            }
          }
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type NumeratorListResult = {
          numerators: NumeratorItem[]
        }
        
        try {
          // documentgenerator.numerator.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<NumeratorListResult>({
            method: 'documentgenerator.numerator.list',
            params: {
              start: 0,
            },
            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('Numerators:', result.numerators, 'Count:', result.numerators.length)
          }
        } 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 fetchNumeratorList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // documentgenerator.numerator.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'documentgenerator.numerator.list',
                params: {
                  start: 0,
                },
                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('Numerators:', result.numerators, 'Count:', result.numerators.length)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchNumeratorList)
        </script>
        

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.documentgenerator.numerator.list(
                start=0,
            ).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.numerator.list',
                [
                    'start' => 0,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        

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

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.numerator.list',
            [
                'start' => 0,
            ]
        );
        
        print_r($result);
        

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "documentgenerator.numerator.list", b24.Params{
        	"start": 0,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("documentgenerator.numerator.list: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it
        // into a struct matching the response shape shown below on this page.
        fmt.Printf("%s\n", res.Result)