Get a list of signed documents in the company's safe sign.b2e.mysafe.tail

Scope: sign.b2e

Who can execute the method: a user with access to the "Company Safe" section. Available documents depend on the "Access to safe documents" permission level.

The method sign.b2e.mysafe.tail returns a list of signed documents in the company's safe.

The method works only in the context of application authorization.

Method Parameters

Required parameters are marked with *

Name
type

Description

limit
integer

Number of records per page.

The parameter accepts a value from 1 to 50.

By default, 20 records are displayed per page

offset
integer

This parameter is used to manage pagination. It is similar to the standard start parameter.

The page size of results depends on the limit parameter

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 '{"limit":2,"offset":0,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sign.b2e.mysafe.tail

try
        {
        	const response = await $b24.callMethod(
        		'sign.b2e.mysafe.tail',
        		{
        			// Number of records per page. Value from 1 to 50. Default is 20.
        			limit: 2,
        			
        			// Parameter for managing pagination.
        			// Used to specify the offset from the start of the list.
        			offset: 0
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sign.b2e.mysafe.tail',
                    [
                        'limit'  => 2,
                        'offset' => 0
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'sign.b2e.mysafe.tail',
            {
                // Number of records per page. Value from 1 to 50. Default is 20.
                limit: 2,
                
                // Parameter for managing pagination.
                // Used to specify the offset from the start of the list.
                offset: 0
            },
            result => {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sign.b2e.mysafe.tail',
            [
                'limit' => 2, // Number of records per page
                'offset' => 0 // Offset from the start of the list
            ]
        );
        
        if (isset($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo '<PRE>';
            print_r($result['result']);
            echo '</PRE>';
        }

Response Handling

HTTP status: 200

{
            "result": [
                {
                    "id": 59,
                    "title": "test-pdf e",
                    "create_date": "2024-06-28T19:07:03+02:00",
                    "signed_date": "2024-06-28T19:34:58+02:00",
                    "creator_id": 1,
                    "member_id": 1,
                    "role": "signer",
                    "file_url": "https://your-domain.bitrix24.com/rest/download.json?auth=7e34b4670000071b0075444600000037f0f1072e5aa442013dece15a3df95d26ed4873&token=sign.b2e%7CaWQ9NTkmXz1IVEVndlJnZUttZUFkeERtaVBRbkhwZkhhTEJFZklpYQ%3D%3D%7CImRvd25sb2FkfHNpZ24uYjJlfGFXUTlOVGttWHoxSVZFVm5kbEpuWlV0dFpVRmtlRVJ0YVZCUmJraHdaa2hoVEVKRlprbHBZUT09fDdlMzRiNDY3MDAwMDA3MWIwMDc1NDQ0NjAwMDAwMDM3ZjBmMTA3MmU1YWE0NDIwMTNkZWNlMTVhM2RmOTVkMjZlZDQ4NzMi.8C%2B3HpNFR5C0YkzTeVL%2FdhE6QJYN66CGoDzZG4VeR4Q%3D"
                },
                {
                    "id": 55,
                    "title": "test-pdf 778484",
                    "create_date": "2024-06-28T18:37:37+02:00",
                    "signed_date": "2024-06-28T18:39:47+02:00",
                    "creator_id": 19,
                    "member_id": 1,
                    "role": "signer",
                    "file_url": "https://your-domain.bitrix24.com/rest/download.json?auth=7e34b4670000071b0075444600000037f0f1072e5aa442013dece15a3df95d26ed4873&token=sign.b2e%7CaWQ9NTUmXz12czNjZDhyM3g2SUZYdzByRVZBbVJIYzZTY3dxZUFxbw%3D%3D%7CImRvd25sb2FkfHNpZ24uYjJlfGFXUTlOVFVtWHoxMmN6TmpaRGh5TTNnMlNVWllkekJ5UlZaQmJWSklZelpUWTNkeFpVRnhidz09fDdlMzRiNDY3MDAwMDA3MWIwMDc1NDQ0NjAwMDAwMDM3ZjBmMTA3MmU1YWE0NDIwMTNkZWNlMTVhM2RmOTVkMjZlZDQ4NzMi.r6Khc2bwTlEANXvuAptaut0Z%2F6y1nGx%2FZhRKqEGkjk0%3D"
                }
            ],
            "time": {
                "start": 1739859574.5550749,
                "finish": 1739859574.595099,
                "duration": 0.0400240421295166,
                "processing": 0.0148630142211914,
                "date_start": "2025-02-18T09:19:34+02:00",
                "date_finish": "2025-02-18T09:19:34+02:00",
                "operating_reset_at": 1739860174,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	The root element of the response. Contains information about signed documents in the company's safe
time `time`	Information about the request execution time

Response Element result

Name `type`	Description
id `integer`	Identifier of the signed document
title `string`	Document title
create_date `string`	Document creation date
signed_date `string`	Document signing date
creator_id `integer`	Identifier of the user who created the document
member_id `integer`	Identifier of the user with whom the document is signed
role `string`	Employee's role in the document: editor — filler reviewer — approver assignee — company representative signer - employee
file_url `string`	Link to download the signed document

Error Handling

HTTP status: 401

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Current authorization type is denied for this method Application context required"
        }

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

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

List of User-Signed Documents

Overview of Methods

Get a list of signed documents in the company's safe sign.b2e.mysafe.tail

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Response Element resultResponse Element result

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning