Dành cho AI agent: markdown của trang này — /docs-content-en/sign-b2e/get-hcm-document.md chỉ mục tài liệu — /llms.txt

Hiện tại, các bài viết trong tài liệu chỉ có bằng tiếng Anh.

Get an HCM Link HR document

GET /v1/sign-b2e/hcmlink/documents/:id

Returns details of a signed document by its member ID. Requires administrator OAuth; the HCM Link integration must be available on the Bitrix24 side.

Scopes: sign.b2e.

Available only to an OAuth application key with a user session. An incoming webhook receives 422 BITRIX_ERROR with the native WRONG_AUTH_TYPE code in error.b24Code.

Path parameters

Parameter Type Required Description
Parameterid Typestring Requiredyes DescriptionNumeric member ID of the signed HCM Link document; this is not the document UID.

Examples

curl — OAuth application

Terminal
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/hcmlink/documents/7' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN'

JavaScript — OAuth application

javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/hcmlink/documents/7', {
  "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.company Typestring DescriptionHCM Link company code.
Fielddata.employee Typestring DescriptionHCM Link employee code.
Fielddata.document Typeobject DescriptionSigned document and file details.
Fielddata.document.date Typestring DescriptionDocument creation date in ATOM format.
Fielddata.document.name Typestring DescriptionDocument title.
Fielddata.document.fileUrl Typestring DescriptionFile URL; credential-bearing links are hidden.
Fielddata.document.fileName Typestring DescriptionSigned file name.
Fielddata.document.uid Typestring | null DescriptionHCM Link document UID, or null.
Fielddata.document.documentUid Typestring | null DescriptionSigning document UID, or null.
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.

JSON
{
  "success": true,
  "data": {
    "company": "DUMMY_COMPANY_CODE",
    "employee": "DUMMY_EMPLOYEE_CODE",
    "document": {
      "date": "2026-11-13T12:00:00+00:00",
      "name": "VIBE-PROBE",
      "fileUrl": "[REDACTED]",
      "fileName": "VIBE-PROBE.pdf",
      "uid": "DUMMY_MEMBER_UID",
      "documentUid": "DUMMY_DOCUMENT_UID"
    }
  },
  "meta": {
    "redacted": [
      "/data/document/fileUrl"
    ]
  }
}

Error response example

403 — the key lacks a required scope:

JSON
{
  "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.
HTTP422 CodeBITRIX_ERROR ReasonAn incoming webhook was used instead of OAuth. The native WRONG_AUTH_TYPE code is in error.b24Code.

Common API errors.

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.

The native method requires only sign.b2e: there is no separate humanresources.hcmlink check. Bitrix24 checks the OAuth context, administrator permissions and HR e-signature availability (sign/lib/Rest/B2e/HcmLink/SignedFile.php:25–38,98–115). In this method family, the additional HCM scope is required only for the HCM parameters when sending a document and for listing company providers.

See also