Get a list of signed documents for the user sign.b2e.personal.tail
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
sign.b2eWho can execute the method: a user with access to their signed documents
The method sign.b2e.personal.tail returns a list of signed documents for the user from the e-Signature for HR section.
The method works only in the context of authorization of the application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
limit |
Number of records per page. The parameter accepts a value from 1 to 1000. By default, 20 records are displayed per page |
|
offset |
This parameter is used for pagination control. It is similar to the standard parameter start. The page size of results depends on the limit parameter |
Code Examples
How to Use Examples in Documentation
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.personal.tail
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each signed document returned in result[]
type SignedDocumentItem = {
id: number
title: string
signed_date: ISODate | null
file_url: string
}
try {
const response = await $b24.actions.v2.call.make<SignedDocumentItem[]>({
method: 'sign.b2e.personal.tail',
params: {
// Number of records per page. Value from 1 to 1000. Default is 20.
limit: 2,
// Offset for pagination (analogous to the standard start parameter).
offset: 0,
},
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('Signed documents:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 fetchSignedDocuments() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sign.b2e.personal.tail',
params: {
// Number of records per page. Value from 1 to 1000. Default is 20.
limit: 2,
// Offset for pagination (analogous to the standard start parameter).
offset: 0,
},
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('Signed documents:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchSignedDocuments)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sign.b2e.personal.tail(
limit=2,
offset=0,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'sign.b2e.personal.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.personal.tail',
{
// Number of records per page. Value from 1 to 1000. Default is 20.
limit: 2,
// Parameter for pagination control.
// 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.personal.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>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "sign.b2e.personal.tail", b24.Params{
"limit": 2,
"offset": 0,
})
if err != nil {
return fmt.Errorf("sign.b2e.personal.tail: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
Title string `json:"title"`
SignedDate string `json:"signed_date"`
FileURL string `json:"file_url"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Title)
}
Response Handling
HTTP status: 200
{
"result": [
{
"id": 59,
"title": "test-pdf e",
"signed_date": "2024-06-28T19:34:58+02:00",
"file_url": "https://your-domain.bitrix24.com/rest/download.json?auth=6348b367...&token=sign.b2e..."
},
{
"id": 55,
"title": "test-pdf 778484",
"signed_date": "2024-06-28T18:39:47+02:00",
"file_url": "https://your-domain.bitrix24.com/rest/download.json?auth=6348b367...&token=sign.b2e..."
}
],
"time": {
"start": 1739799244.3062601,
"finish": 1739799244.3473959,
"duration": 0.04113578796386719,
"processing": 0.01007699966430664,
"date_start": "2025-02-17T16:34:04+02:00",
"date_finish": "2025-02-17T16:34:04+02:00",
"operating_reset_at": 1739799844,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response. Contains information about the user's signed documents |
|
time |
Information about the request execution time |
Response Element result
|
Name |
Description |
|
id |
Identifier of the signed document |
|
title |
Title of the document |
|
signed_date |
Date of signing the document |
|
file_url |
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 |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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 |