Для AI-агентов: markdown этой страницы — /docs-content/sign-b2e/get-document.md индекс документации — /llms.txt
Получить документ
GET /v1/sign-b2e/documents/:uid
Возвращает состояние документа и его участников. Нужны права чтения документов и доступ к конкретному документу.
Скоупы: sign.b2e, crm.
Параметры пути
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрuid |
Типstring | Обяз.да | ОписаниеИдентификатор документа из результата отправки документа. |
Параметры запроса (query)
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
Параметрlanguage |
Типstring | Обяз.нет | ОписаниеЯзык названий состояний, по умолчанию en; неизвестный язык заменяется en. |
Примеры
curl — личный ключ
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/documents/DUMMY_DOCUMENT_UID' \
-H 'X-Api-Key: YOUR_API_KEY'
curl — OAuth-приложение
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/documents/DUMMY_DOCUMENT_UID' \
-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/documents/DUMMY_DOCUMENT_UID', {
"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/documents/DUMMY_DOCUMENT_UID', {
"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 |
Типobject | ОписаниеДанные операции. |
Полеdata.uid |
Типstring | null | ОписаниеUID документа. |
Полеdata.state |
Типobject | null | ОписаниеСостояние объекта. |
Полеdata.state.code |
Типstring | null | ОписаниеМашинный код. |
Полеdata.state.name |
Типstring | null | ОписаниеЛокализованное название состояния подписи. |
Полеdata.members |
Типarray | ОписаниеУчастники документа. |
Полеdata.members[].uid |
Типstring | null | ОписаниеUID участника подписи. |
Полеdata.members[].role |
Типstring | null | ОписаниеРоль участника. |
Полеdata.members[].state |
Типobject | null | ОписаниеСостояние объекта. |
Полеdata.members[].state.code |
Типstring | null | ОписаниеМашинный код. |
Полеdata.members[].state.name |
Типstring | null | ОписаниеЛокализованное название состояния подписи. |
Полеdata.members[].user |
Типobject | null | ОписаниеПользователь участника. |
Полеdata.members[].party |
Типinteger | null | ОписаниеНомер стороны подписания участника. |
Полеdata.members[].user.employeeCode |
Типstring | null | ОписаниеКод сотрудника HCM Link; null для обычного пользователя. |
Полеdata.members[].user.employeeId |
Типinteger | null | ОписаниеЧисловой ID сотрудника HCM Link; null для обычного пользователя. |
Полеdata.members[].user.userId |
Типinteger | null | ОписаниеИдентификатор пользователя. |
Полеmeta.redacted |
Типarray | ОписаниеПрисутствует при скрытии учётных данных; содержит пути изменённых значений. |
Пример ответа
Форма успешного ответа; данные зависят от портала и запроса.
{
"success": true,
"data": {
"uid": "DUMMY_DOCUMENT_UID",
"state": {
"code": "ready",
"name": "Ready"
},
"members": []
}
}
Пример ответа при ошибке
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. |
Известные особенности
Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.