# sign.b2e.document.get

URL: https://chugunov.pro/api-bitrix24/sign/sign-b2e-document-get/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить документ
Scope: `sign.b2e, crm`
Кто может выполнять метод: пользователь с правом просмотра документов КЭДО

## Описание

Метод `sign.b2e.document.get` возвращает информацию о документе и участниках подписания.

Метод работает только в контексте авторизации [приложения](https://apidocs.bitrix24.ru/settings/app-installation/index.html).

## Параметры

- `uid` `string` — необязательный. Уникальный идентификатор документа
- `language` `string` — необязательный. Язык локализации статусов в ответе.
  По умолчанию `en`

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "uid": "b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c",
        "state": {
            "code": "in_progress",
            "name": "В процессе"
        },
        "members": [
            {
                "uid": "f1c2d3e4",
                "role": "signer",
                "party": 0,
                "user": {
                    "employeeCode": "EMP-001",
                    "employeeId": 123,
                    "userId": 25
                },
                "state": {
                    "code": "signed",
                    "name": "Подписано"
                }
            }
        ]
    },
    "time": {
        "start": 1739860000.123,
        "finish": 1739860000.456,
        "duration": 0.333,
        "processing": 0.111,
        "date_start": "2025-02-18T09:19:34+03:00",
        "date_finish": "2025-02-18T09:19:34+03:00",
        "operating_reset_at": 1739860600,
        "operating": 0
    }
}
```

### Возвращаемые данные

- `result` `object`. Информация о документе и участниках подписания
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 200

```json
{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied!"
}
```

- `ACCESS_DENIED` — Access denied!. Недостаточно прав
- `WRONG_AUTH_TYPE` — Current authorization type is denied for this method. Вызов не из контекста приложения
- `INTERNAL_ERROR` — Internal error. Ошибка при формировании ответа
- — — Document UID is required. Не передан параметр `uid`
- — — Document not found. Документ с указанным `uid` не найден

## Примеры запроса

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"uid":"b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sign.b2e.document.get
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type DocumentGetResult = {
  uid: string
  state: {
    code: string
    name: string
  }
  members: {
    uid: string
    role: string
    party: number
    user: {
      employeeCode: string
      employeeId: number
      userId: number
    }
    state: {
      code: string
      name: string
    }
  }[]
}

try {
  const response = await $b24.actions.v2.call.make<DocumentGetResult>({
    method: 'sign.b2e.document.get',
    params: {
      uid: 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
      language: 'ru',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.uid, result.state.code, result.members.length)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getDocument() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sign.b2e.document.get',
        params: {
          uid: 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
          language: 'ru',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.uid, result.state.code, result.members.length)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getDocument)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sign.b2e.document.get(
        uid="b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c",
        language="ru",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'sign.b2e.document.get',
            [
                'uid' => 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
                'language' => 'ru'
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}
```

### BX24.js

```javascript
BX24.callMethod(
    'sign.b2e.document.get',
    {
        uid: 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
        language: 'ru'
    },
    result => {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.dir(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'sign.b2e.document.get',
    [
        'uid' => 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
        'language' => 'ru'
    ]
);

if (isset($result['error'])) {
    echo 'Ошибка: ' . $result['error_description'];
} else {
    echo '<PRE>';
    print_r($result['result']);
    echo '</PRE>';
}
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sign.b2e.document.get", b24.Params{
	"uid": "b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("sign.b2e.document.get: %w", err)
}

var item struct {
	Uid string `json:"uid"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Uid)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/sign/sign-b2e-document-get.html