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.
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 |
Description |
|
companyUuid* |
UUID of the company in HCM Link. Required if the Requires additional scope |
|
companyCrmId* |
Identifier of the company in CRM, connected in the integration as "my company". Required if the |
|
language |
Language for localizing provider names. Defaults to |
|
limit |
Number of records per page. The parameter accepts values from 1 to 1000. Defaults to 100 |
|
offset |
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 -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
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each provider item returned in result[]
type ProviderItem = {
code: string
uid: string
name: string
date: ISODate | null
expires: ISODate | null
}
try {
// sign.b2e.company.provider.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<ProviderItem[]>({
method: 'sign.b2e.company.provider.list',
params: {
// UUID of the company in HCM Link or its CRM company ID
companyCrmId: 12,
// Language for provider name localization
language: 'en',
// Pagination parameters
limit: 2,
offset: 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(result.length, result[0]?.name, result[0]?.uid)
}
} 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 fetchCompanyProviders() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sign.b2e.company.provider.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: 'sign.b2e.company.provider.list',
params: {
// UUID of the company in HCM Link or its CRM company ID
companyCrmId: 12,
// Language for provider name localization
language: 'en',
// Pagination parameters
limit: 2,
offset: 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(result.length, result[0]?.name, result[0]?.uid)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchCompanyProviders)
</script>
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 |
Description |
|
result |
List of signature providers for the company |
|
time |
Information about the request execution time |
Element of the result array
|
Name |
Description |
|
code |
Provider code |
|
uid |
Unique identifier of the provider |
|
name |
Name of the provider considering the language |
|
date |
Registration date of the provider in ISO 8601 format |
|
expires |
Expiration date of the provider in ISO 8601 format |
Error Handling
HTTP Status: 200
{
"error": "ACCESS_DENIED",
"error_description": "Access denied!"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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! |
Insufficient permissions |
|
|
Current authorization type is denied for this method |
Call not from application context |
|
|
Company was not found. |
Company not found by |
|
|
My company ... not found |
CRM company not found |
|
|
Parameter 'companyUuid' or 'companyCrmId' is required |
Company identifiers not provided |
|
|
humanresources module is not installed |
|
|
|
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 |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |