For AI agents: markdown of this page — /docs-content-en/sign-b2e/list-company-providers.md documentation index — /llms.txt

List company providers

GET /v1/sign-b2e/company-providers

Returns the signature providers of your own company. Requires permission to create documents. Reading can automatically register virtual providers; automatic retries are disabled.

Scopes: sign.b2e, crm.

Query parameters

Parameter Type Required Description
ParametercompanyCrmId Typeinteger | string Requiredno DescriptionYour own company ID from the list of companies. Pass either this or companyUuid.
ParametercompanyUuid Typestring Requiredno DescriptionHCM Link company UUID. Requires humanresources.hcmlink; used instead of companyCrmId.
Parameterlimit Typeinteger | string Requiredno DescriptionDefaults to 100; from 1 to 1000. Bitrix24 rejects values outside this range.
Parameteroffset Typeinteger | string Requiredno DescriptionOffset from the start of the list; 0 by default.
Parameterlanguage Typestring Requiredno DescriptionLanguage of provider names, en by default; an unknown language is replaced with en.

Examples

curl — personal key

Terminal
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/company-providers?companyCrmId=7' \
  -H 'X-Api-Key: YOUR_API_KEY'

curl — OAuth application

Terminal
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/company-providers?companyCrmId=7' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN'

JavaScript — personal key

javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/company-providers?companyCrmId=7', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY"
  }
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

JavaScript — OAuth application

javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/company-providers?companyCrmId=7', {
  "method": "GET",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN"
  }
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionWhether the request succeeded.
Fielddata Typearray DescriptionOperation data.
Fielddata[].code Typestring DescriptionMachine-readable code.
Fielddata[].uid Typestring DescriptionCompany provider UID used to send a document.
Fielddata[].name Typestring DescriptionState name or user name.
Fielddata[].date Typestring | null DescriptionProvider connection date in ATOM format, or null.
Fielddata[].expires Typestring | null DescriptionProvider expiry date in ATOM format, or null.
Fieldmeta.redacted Typearray DescriptionPresent when credentials are hidden; contains the paths of the replaced values.

Response example

Shape of a successful response; the data depends on the Bitrix24 account and the request.

JSON
{
  "success": true,
  "data": []
}

Error response example

403 — the key lacks a required scope:

JSON
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sign.b2e' scope"
  }
}

Errors

HTTP Code Reason
HTTP400 CodeINVALID_PARAMS ReasonInvalid request shape: types, required fields or an unknown query string parameter.
HTTP401 CodeTOKEN_MISSING ReasonNo credentials for the Bitrix24 connection.
HTTP403 CodeSCOPE_DENIED ReasonOne of the required scopes is not granted.
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY ReasonThe key is READONLY: the native read can register virtual providers.
HTTP422 CodeBITRIX_ERROR ReasonBitrix24 rejected the operation; the code is in error.b24Code, the text in error.message.

Common API errors.

Known specifics

Bitrix24 checks user permissions, HR e-signature availability, business rules, page sizes and field contents. Values are passed through without local correction. Response text is JSON-encoded; credential-bearing links are hidden.

The operation is not retried automatically. If the outcome is unknown, check the state in the Bitrix24 account first; repeating the call can repeat the operation.

Although this is a GET request, it requires a READWRITE key. The Bitrix24 core can trigger company registration with a provider (sign/lib/Rest/B2e/CompanyProvider.php:118,323–343), so the standard write block rejects a READONLY key before Bitrix24 is called. Automatic retries are disabled both in the classifier and in the request-processing pipeline.

See also