Get the List of Providers for sign.b2e.company.provider.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: sign.b2e, crm

Who can execute the method: a user with permission to create KEDO documents

The method sign.b2e.company.provider.list returns a list of signature providers for the selected company.

The method works only in the context of application authorization application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
companyUuid* `string`	UUID of the company in HCM Link. Required if the `companyCrmId` parameter is not provided. Requires additional scope `humanresources.hcmlink`
companyCrmId* `integer`	Identifier of the company in CRM, connected in the integration as "my company". Required if the `companyUuid` parameter is not provided
language `string`	Language for localizing provider names. Defaults to `en`
limit `integer`	Number of records per page. The parameter accepts values from 1 to 1000. Defaults to 100
offset `integer`	Parameter for managing pagination. Defaults to 0

You must provide either the companyUuid or companyCrmId parameter.

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"companyCrmId":12,"limit":2,"offset":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sign.b2e.company.provider.list

try
        {
            const response = await $b24.callMethod(
                'sign.b2e.company.provider.list',
                {
                    // UUID of the company in HCM Link or ID of the company in CRM
                    companyCrmId: 12,
        
                    // Language for localizing provider names
                    language: 'de',
        
                    // Pagination parameters
                    limit: 2,
                    offset: 0
                }
            );
        
            const result = response.getData().result;
            console.dir(result);
        }
        catch( error )
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sign.b2e.company.provider.list',
                    [
                        'companyCrmId' => 12,
                        'language' => 'de',
                        'limit' => 2,
                        'offset' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'sign.b2e.company.provider.list',
            {
                companyCrmId: 12,
                language: 'de',
                limit: 2,
                offset: 0
            },
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sign.b2e.company.provider.list',
            [
                'companyCrmId' => 12,
                'language' => 'de',
                'limit' => 2,
                'offset' => 0
            ]
        );
        
        if (isset($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo '<PRE>';
            print_r($result['result']);
            echo '</PRE>';
        }

Response Handling

HTTP Status: 200

{
            "result": [
                {
                    "code": "ses-de",
                    "uid": "d4f6b8a1-4c6d-4d8c-9c7c-2d1b1f6d0f2b",
                    "name": "Bitrix24 KEDO",
                    "date": "2025-02-18T10:15:30+01:00",
                    "expires": "2026-02-18T10:15:30+01:00"
                }
            ],
            "time": {
                "start": 1739860000.123,
                "finish": 1739860000.456,
                "duration": 0.333,
                "processing": 0.111,
                "date_start": "2025-02-18T09:19:34+01:00",
                "date_finish": "2025-02-18T09:19:34+01:00",
                "operating_reset_at": 1739860600,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `array`	List of signature providers for the company
time `time`	Information about the request execution time

Element of the result array

Name `type`	Description
code `string`	Provider code
uid `string`	Unique identifier of the provider
name `string`	Name of the provider considering the language
date `string`	Registration date of the provider in ISO 8601 format
expires `string`	Expiration date of the provider in ISO 8601 format

Error Handling

HTTP Status: 200

{
            "error": "ACCESS_DENIED",
            "error_description": "Access denied!"
        }

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	When it occurs
`ACCESS_DENIED`	Access denied!	Insufficient permissions
`WRONG_AUTH_TYPE`	Current authorization type is denied for this method	Call not from application context
`510`	Company was not found.	Company not found by `companyUuid` or `companyCrmId`
`510`	My company ... not found	CRM company not found
`-`	Parameter 'companyUuid' or 'companyCrmId' is required	Company identifiers not provided
`-`	humanresources module is not installed	`humanresources` module not installed when using `companyUuid`
`-`	Error while autoregistering providers	Error in auto-registering virtual providers. Check my company data in CRM

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

Retrieve Document

List of User-Signed Documents

Get the List of Providers for sign.b2e.company.provider.list

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Element of the result arrayElement of the result array

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning