Для AI-агентов: markdown этой страницы — /docs-content/sign-b2e/list-company-providers.md индекс документации — /llms.txt
Список провайдеров компании
GET /v1/sign-b2e/company-providers
Возвращает провайдеров подписи собственной компании. Нужны права создания документов. Чтение может автоматически зарегистрировать виртуальных провайдеров; автоматические повторы отключены.
Скоупы: sign.b2e, crm.
Параметры запроса (query)
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрcompanyCrmId |
Типinteger | string | Обяз.нет | ОписаниеИдентификатор собственной компании из списка компаний. Передайте его или companyUuid. |
ПараметрcompanyUuid |
Типstring | Обяз.нет | ОписаниеUUID компании HCM Link. Требует humanresources.hcmlink; вместо companyCrmId. |
Параметрlimit |
Типinteger | string | Обяз.нет | ОписаниеПо умолчанию 100; от 1 до 1000. Выход за диапазон отклоняет Битрикс24. |
Параметрoffset |
Типinteger | string | Обяз.нет | ОписаниеСмещение от начала списка; по умолчанию 0. |
Параметрlanguage |
Типstring | Обяз.нет | ОписаниеЯзык названий провайдеров, по умолчанию en; неизвестный язык заменяется en. |
Примеры
curl — личный ключ
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/company-providers?companyCrmId=7' \
-H 'X-Api-Key: YOUR_API_KEY'
curl — OAuth-приложение
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/company-providers?companyCrmId=7' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN'
JavaScript — личный ключ
const response = await fetch('https://vibecode.bitrix24.tech/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-приложение
const response = await fetch('https://vibecode.bitrix24.tech/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);
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеУспешность запроса. |
Полеdata |
Типarray | ОписаниеДанные операции. |
Полеdata[].code |
Типstring | ОписаниеМашинный код. |
Полеdata[].uid |
Типstring | ОписаниеUID провайдера компании для отправки документа. |
Полеdata[].name |
Типstring | ОписаниеНазвание состояния или имя пользователя. |
Полеdata[].date |
Типstring | null | ОписаниеДата подключения провайдера в ATOM или null. |
Полеdata[].expires |
Типstring | null | ОписаниеДата окончания действия провайдера в ATOM или null. |
Полеmeta.redacted |
Типarray | ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений. |
Пример ответа
Форма успешного ответа; данные зависят от портала и запроса.
{
"success": true,
"data": []
}
Пример ответа при ошибке
403 — ключу не выдан обязательный скоуп:
{
"success": false,
"error": {
"code": "SCOPE_DENIED",
"message": "This endpoint requires 'sign.b2e' scope"
}
}
Ошибки
| HTTP | Код | Причина |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ПричинаНеверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса. |
| HTTP401 | КодTOKEN_MISSING |
ПричинаНет учётных данных соединения с Битрикс24. |
| HTTP403 | КодSCOPE_DENIED |
ПричинаНе выдан один из обязательных скоупов. |
| HTTP403 | КодWRITE_BLOCKED_READONLY_KEY |
ПричинаКлюч READONLY: нативное чтение может регистрировать виртуальных провайдеров. |
| HTTP422 | КодBITRIX_ERROR |
ПричинаБитрикс24 отказал в операции; код в error.b24Code, текст в error.message. |
Известные особенности
Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.
Операция автоматически не повторяется. При неизвестном результате сначала выясните состояние на портале; повторный вызов может повторно выполнить операцию.
Несмотря на GET, требуется ключ READWRITE. Ядро может вызвать регистрацию компании у провайдера (sign/lib/Rest/B2e/CompanyProvider.php:118,323–343), поэтому штатный запрет записи отклоняет READONLY до вызова Битрикс24. Автоповторы отключены и в классификаторе, и в конвейере обработки запросов.