For AI agents: markdown of this page — /docs-content-en/sign-b2e/list-providers.md documentation index — /llms.txt
List external providers
GET /v1/sign-b2e/providers
Returns external signature providers. Can be called by an administrator via OAuth.
Scopes: sign.b2e.
Available only to an OAuth application key with a user session. An incoming webhook receives 422 BITRIX_ERROR with the native WRONG_AUTH_TYPE code in error.b24Code.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
Parameterlimit |
Typeinteger | string | Requiredno | DescriptionDefaults to 20; from 1 to 1000. Bitrix24 replaces an invalid value with 20. |
Parameteroffset |
Typeinteger | string | Requiredno | DescriptionOffset from the start of the list; 0 by default. |
Examples
curl — OAuth application
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/providers' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN'
JavaScript — OAuth application
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/providers', {
"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[].id |
Typeinteger | DescriptionObject ID. |
Fielddata[].title |
Typestring | DescriptionObject name. |
Fielddata[].description |
Typestring | DescriptionProvider description. |
Fielddata[].iconUri |
Typestring | DescriptionIcon URL. |
Fielddata[].companyRegUri |
Typestring | null | DescriptionCompany registration URL. |
Fielddata[].documentSignUri |
Typestring | DescriptionSigning URL. |
Fielddata[].publicKeyUri |
Typestring | DescriptionPublic key URL. |
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.
{
"success": true,
"data": []
}
Error response example
403 — the key lacks a required scope:
{
"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. |
| HTTP422 | CodeBITRIX_ERROR |
ReasonBitrix24 rejected the operation; the code is in error.b24Code, the text in error.message. |
| HTTP422 | CodeBITRIX_ERROR |
ReasonAn incoming webhook was used instead of OAuth. The native WRONG_AUTH_TYPE code is in error.b24Code. |
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 default page size is 20, the maximum is 1000. An invalid limit is replaced with 20, an invalid offset with 0. Bitrix24 applies these rules.