YZ ajanları için: bu sayfanın markdown'ı — /docs-content-en/sign-b2e/get-document.md dokümantasyon dizini — /llms.txt
Dokümantasyon makaleleri şu anda İngilizce olarak mevcuttur.
Get a document
GET /v1/sign-b2e/documents/:uid
Returns the state of a document and its members. Requires permission to read documents and access to the specific document.
Scopes: sign.b2e, crm.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
Parameteruid |
Typestring | Requiredyes | DescriptionDocument ID returned when the document was sent. |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
Parameterlanguage |
Typestring | Requiredno | DescriptionLanguage of state names, en by default; an unknown language falls back to en. |
Examples
curl — personal key
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/documents/DUMMY_DOCUMENT_UID' \
-H 'X-Api-Key: YOUR_API_KEY'
curl — OAuth application
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/documents/DUMMY_DOCUMENT_UID' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN'
JavaScript — personal key
const response = await fetch('https://vibecode.bitrix24.com/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 application
const response = await fetch('https://vibecode.bitrix24.com/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);
Response fields
| Field | Type | Description |
|---|---|---|
Fieldsuccess |
Typeboolean | DescriptionWhether the request succeeded. |
Fielddata |
Typeobject | DescriptionOperation data. |
Fielddata.uid |
Typestring | null | DescriptionDocument UID. |
Fielddata.state |
Typeobject | null | DescriptionObject state. |
Fielddata.state.code |
Typestring | null | DescriptionMachine-readable code. |
Fielddata.state.name |
Typestring | null | DescriptionLocalized signing state name. |
Fielddata.members |
Typearray | DescriptionDocument members. |
Fielddata.members[].uid |
Typestring | null | DescriptionSigning member UID. |
Fielddata.members[].role |
Typestring | null | DescriptionMember role. |
Fielddata.members[].state |
Typeobject | null | DescriptionObject state. |
Fielddata.members[].state.code |
Typestring | null | DescriptionMachine-readable code. |
Fielddata.members[].state.name |
Typestring | null | DescriptionLocalized signing state name. |
Fielddata.members[].user |
Typeobject | null | DescriptionUser linked to the member. |
Fielddata.members[].party |
Typeinteger | null | DescriptionSigning party number of the member. |
Fielddata.members[].user.employeeCode |
Typestring | null | DescriptionHCM Link employee code; null for a regular user. |
Fielddata.members[].user.employeeId |
Typeinteger | null | DescriptionNumeric HCM Link employee ID; null for a regular user. |
Fielddata.members[].user.userId |
Typeinteger | null | DescriptionUser ID. |
Fieldmeta.redacted |
Typearray | DescriptionPresent when credentials are hidden; contains the paths of the replaced values. |
Response example
Shape of a successful response; the data depends on the Bitrix24 account and the request.
{
"success": true,
"data": {
"uid": "DUMMY_DOCUMENT_UID",
"state": {
"code": "ready",
"name": "Ready"
},
"members": []
}
}
Error response example
403 — the key lacks a required scope:
{
"success": false,
"error": {
"code": "SCOPE_DENIED",
"message": "This endpoint requires 'sign.b2e' scope"
}
}
Errors
| HTTP | Code | Reason |
|---|---|---|
| HTTP400 | CodeINVALID_PARAMS |
ReasonInvalid request shape: types, required fields or an unknown query string parameter. |
| HTTP401 | CodeTOKEN_MISSING |
ReasonNo credentials for the Bitrix24 connection. |
| HTTP403 | CodeSCOPE_DENIED |
ReasonOne of the required scopes is not granted. |
| HTTP422 | CodeBITRIX_ERROR |
ReasonBitrix24 rejected the operation; the code is in error.b24Code, the text in error.message. |
Known specifics
Bitrix24 checks user permissions, HR e-signature availability, business rules, page sizes and field contents. Values are passed through without local correction. Response text is JSON-encoded; credential-bearing links are hidden.