# Получить документ

`GET /v1/sign-b2e/documents/:uid`

Возвращает состояние документа и его участников. Нужны права чтения документов и доступ к конкретному документу.

**Скоупы:** `sign.b2e`, `crm`.

## Параметры пути

| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| `uid` | string | да | Идентификатор документа из результата отправки документа. |

## Параметры запроса (query)

| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
| `language` | string | нет | Язык названий состояний, по умолчанию en; неизвестный язык заменяется en. |

## Примеры

### curl — личный ключ

```bash
curl -X GET 'https://vibecode.bitrix24.tech/v1/sign-b2e/documents/DUMMY_DOCUMENT_UID' \
  -H 'X-Api-Key: YOUR_API_KEY'
```

### curl — OAuth-приложение

```bash
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 — личный ключ

```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-приложение

```javascript
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<string> | Присутствует при скрытии учётных данных; содержит пути изменённых значений. |

## Пример ответа

Форма успешного ответа; данные зависят от портала и запроса.

```json
{
  "success": true,
  "data": {
    "uid": "DUMMY_DOCUMENT_UID",
    "state": {
      "code": "ready",
      "name": "Ready"
    },
    "members": []
  }
}
```

## Пример ответа при ошибке

403 — ключу не выдан обязательный скоуп:

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

## Ошибки

| HTTP | Код | Причина |
|---|---|---|
| 400 | `INVALID_PARAMS` | Неверная форма запроса: типы, обязательные поля или неизвестный параметр строки запроса. |
| 401 | `TOKEN_MISSING` | Нет учётных данных соединения с Битрикс24. |
| 403 | `SCOPE_DENIED` | Не выдан один из обязательных скоупов. |
| 422 | `BITRIX_ERROR` | Битрикс24 отказал в операции; код в error.b24Code, текст в error.message. |

[Общие ошибки API](/docs/errors).

## Известные особенности

Права пользователя, доступность КЭДО, бизнес-правила, размеры страниц и содержимое полей проверяет Битрикс24. Значения передаются без локального исправления. Текст ответа кодируется в JSON; ссылки с учётными данными скрываются.

## Смотрите также

- [Подпись сотрудников](/docs/sign-b2e)
- [Ошибки API](/docs/errors)
