Для AI-агентов: markdown этой страницы — /docs-content/sign-b2e/list-legal-fields.md индекс документации — /llms.txt
Список юридических полей
Доступно начиная с модуля sign 26.1300.0. На старых коробочных установках метод может быть недоступен: платформа вернёт
422 METHOD_NOT_YET_AVAILABLEсerror.release.
GET /v1/sign-b2e/legal-fields
Возвращает коды, форматы, подписи, возможность записи и подстановки юридических полей. Владельцу ключа нужны права просмотра юридических данных сотрудников.
Скоупы: sign.b2e.
Примеры
curl — личный ключ
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/legal-fields' \
-H 'X-Api-Key: YOUR_API_KEY'
curl — OAuth-приложение
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/legal-fields' \
-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/legal-fields', {
"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/legal-fields', {
"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[].type |
Типstring | ОписаниеФормат значения: string, snils, inn, date, address, url, enumeration, fullname. Неизвестный формат считайте недоступным для записи. |
Полеdata[].caption |
Типstring | ОписаниеПодпись поля на языке портала. |
Полеdata[].writable |
Типboolean | ОписаниеМожно ли записать значение поля. |
Полеdata[].signerPlaceholder |
Типstring | null | ОписаниеПодстановка сотрудника в DOCX; null, если нет. |
Полеdata[].assigneePlaceholder |
Типstring | null | ОписаниеПодстановка представителя в DOCX; null, если нет. |
Полеdata[].options |
Типarray | null | ОписаниеВарианты списка; null для других форматов. |
Полеdata[].options[].id |
Типinteger | string | ОписаниеИдентификатор объекта. |
Полеdata[].options[].value |
Типstring | ОписаниеНазвание варианта списка. |
Поле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 |
ПричинаНе выдан один из обязательных скоупов. |
| HTTP422 | КодBITRIX_ERROR |
ПричинаБитрикс24 отказал в операции; код в error.b24Code, текст в error.message. |
| HTTP422 | КодMETHOD_NOT_YET_AVAILABLE |
ПричинаМетода ещё нет на портале; выпуск в error.release. |
Известные особенности
Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.