Get Document sign.b2e.document.get

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: sign.b2e, crm

Who can execute the method: a user with document viewing access permission in KEDO

The method sign.b2e.document.get returns information about the document and signing participants.

The method works only in the context of application authorization application.

Method Parameters

Required parameters are marked with *

Name
type

Description

uid
string

Unique identifier of the document

language
string

Language for localizing statuses in the response.

Defaults to en

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
        	const response = await $b24.callMethod(
        		'sign.b2e.document.get',
        		{
        			uid: 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
        			language: 'en'
        		}
        	);
        
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sign.b2e.document.get',
                    [
                        'uid' => 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
                        'language' => 'en'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

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

require_once('crest.php');
        
        $result = CRest::call(
            'sign.b2e.document.get',
            [
                'uid' => 'b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c',
                'language' => 'en'
            ]
        );
        
        if (isset($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo '<PRE>';
            print_r($result['result']);
            echo '</PRE>';
        }

Response Handling

HTTP Status: 200

{
            "result": {
                "uid": "b6f5f1f1-9d20-4b6b-ae0f-2f0a8a0c2b3c",
                "state": {
                    "code": "in_progress",
                    "name": "In Progress"
                },
                "members": [
                    {
                        "uid": "f1c2d3e4",
                        "role": "signer",
                        "party": 0,
                        "user": {
                            "employeeCode": "EMP-001",
                            "employeeId": 123,
                            "userId": 25
                        },
                        "state": {
                            "code": "signed",
                            "name": "Signed"
                        }
                    }
                ]
            },
            "time": {
                "start": 1739860000.123,
                "finish": 1739860000.456,
                "duration": 0.333,
                "processing": 0.111,
                "date_start": "2025-02-18T09:19:34+01:00",
                "date_finish": "2025-02-18T09:19:34+01:00",
                "operating_reset_at": 1739860600,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Information about the document and signing participants
time `time`	Information about the request execution time

Fields of the result object

Name `type`	Description
uid `string`	Unique identifier of the document
state `object`	Current status of the document
members `array`	Signing participants

Fields of the result.state object

Name `type`	Description
code `string`	Status code
name `string`	Status name

Element of the result.members array

Name `type`	Description
uid `string`	Unique identifier of the participant
role `string`	Role of the participant
party `integer`	Signing party
user `object`	User data
state `object`	Status of the participant

Fields of the result.members.user object

Name `type`	Description
employeeCode `string`	Employee code in HCM Link. Returned only for companies linked with HCM Link
employeeId `integer`	Employee identifier in HCM Link. Returned only for companies linked with HCM Link
userId `integer`	User identifier in Bitrix24

Fields of the result.members.state object

Name `type`	Description
code `string`	Status code of the participant
name `string`	Status name of the participant

Error Handling

HTTP Status: 200

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	When it occurs
`ACCESS_DENIED`	Access denied!	Insufficient permissions
`WRONG_AUTH_TYPE`	Current authorization type is denied for this method	Call not from application context
`INTERNAL_ERROR`	Internal error	Error generating response
`-`	Document UID is required	Parameter `uid` not provided
`-`	Document not found	Document with the specified `uid` not found

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Send Document for Signature

Get Company Provider List

Get Document sign.b2e.document.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Fields of the result objectFields of the result object

Fields of the result.state objectFields of the result.state object

Element of the result.members arrayElement of the result.members array

Fields of the result.members.user objectFields of the result.members.user object

Fields of the result.members.state objectFields of the result.members.state object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning