[{"data":1,"prerenderedAt":7},["ShallowReactive",2],{"docs-sign-b2e\u002Fget-document":3,"docs-tabs-sign-b2e\u002Fget-document":6},{"content":4,"lastmod":5},"# Get a document\n\n`GET \u002Fv1\u002Fsign-b2e\u002Fdocuments\u002F:uid`\n\nReturns the state of a document and its members. Requires permission to read documents and access to the specific document.\n\n**Scopes:** `sign.b2e`, `crm`.\n\n## Path parameters\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| `uid` | string | yes | Document ID returned when the document was sent. |\n\n## Query parameters\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| `language` | string | no | Language of state names, en by default; an unknown language falls back to en. |\n\n## Examples\n\n### curl — personal key\n\n```bash\ncurl -X GET 'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsign-b2e\u002Fdocuments\u002FDUMMY_DOCUMENT_UID' \\\n  -H 'X-Api-Key: YOUR_API_KEY'\n```\n\n### curl — OAuth application\n\n```bash\ncurl -X GET 'https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsign-b2e\u002Fdocuments\u002FDUMMY_DOCUMENT_UID' \\\n  -H 'X-Api-Key: YOUR_APP_KEY' \\\n  -H 'Authorization: Bearer USER_SESSION_TOKEN'\n```\n\n### JavaScript — personal key\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsign-b2e\u002Fdocuments\u002FDUMMY_DOCUMENT_UID', {\n  \"method\": \"GET\",\n  \"headers\": {\n    \"X-Api-Key\": \"YOUR_API_KEY\"\n  }\n});\nconst result = await response.json();\nif (!response.ok || !result.success) throw new Error(result.error?.message);\nconsole.log(result.data);\n```\n\n### JavaScript — OAuth application\n\n```javascript\nconst response = await fetch('https:\u002F\u002Fvibecode.bitrix24.com\u002Fv1\u002Fsign-b2e\u002Fdocuments\u002FDUMMY_DOCUMENT_UID', {\n  \"method\": \"GET\",\n  \"headers\": {\n    \"X-Api-Key\": \"YOUR_APP_KEY\",\n    \"Authorization\": \"Bearer USER_SESSION_TOKEN\"\n  }\n});\nconst result = await response.json();\nif (!response.ok || !result.success) throw new Error(result.error?.message);\nconsole.log(result.data);\n```\n\n## Response fields\n\n| Field | Type | Description |\n|---|---|---|\n| `success` | boolean | Whether the request succeeded. |\n| `data` | object | Operation data. |\n| `data.uid` | string \\| null | Document UID. |\n| `data.state` | object \\| null | Object state. |\n| `data.state.code` | string \\| null | Machine-readable code. |\n| `data.state.name` | string \\| null | Localized signing state name. |\n| `data.members` | array | Document members. |\n| `data.members[].uid` | string \\| null | Signing member UID. |\n| `data.members[].role` | string \\| null | Member role. |\n| `data.members[].state` | object \\| null | Object state. |\n| `data.members[].state.code` | string \\| null | Machine-readable code. |\n| `data.members[].state.name` | string \\| null | Localized signing state name. |\n| `data.members[].user` | object \\| null | User linked to the member. |\n| `data.members[].party` | integer \\| null | Signing party number of the member. |\n| `data.members[].user.employeeCode` | string \\| null | HCM Link employee code; null for a regular user. |\n| `data.members[].user.employeeId` | integer \\| null | Numeric HCM Link employee ID; null for a regular user. |\n| `data.members[].user.userId` | integer \\| null | User ID. |\n| `meta.redacted` | array\u003Cstring> | Present when credentials are hidden; contains the paths of the replaced values. |\n\n## Response example\n\nShape of a successful response; the data depends on the Bitrix24 account and the request.\n\n```json\n{\n  \"success\": true,\n  \"data\": {\n    \"uid\": \"DUMMY_DOCUMENT_UID\",\n    \"state\": {\n      \"code\": \"ready\",\n      \"name\": \"Ready\"\n    },\n    \"members\": []\n  }\n}\n```\n\n## Error response example\n\n403 — the key lacks a required scope:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"SCOPE_DENIED\",\n    \"message\": \"This endpoint requires 'sign.b2e' scope\"\n  }\n}\n```\n\n## Errors\n\n| HTTP | Code | Reason |\n|---|---|---|\n| 400 | `INVALID_PARAMS` | Invalid request shape: types, required fields or an unknown query string parameter. |\n| 401 | `TOKEN_MISSING` | No credentials for the Bitrix24 connection. |\n| 403 | `SCOPE_DENIED` | One of the required scopes is not granted. |\n| 422 | `BITRIX_ERROR` | Bitrix24 rejected the operation; the code is in error.b24Code, the text in error.message. |\n\n[Common API errors](\u002Fdocs\u002Ferrors).\n\n## Known specifics\n\nBitrix24 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.\n\n## See also\n\n- [Employee signatures](\u002Fdocs\u002Fsign-b2e)\n- [API errors](\u002Fdocs\u002Ferrors)\n","2026-11-18",{},1795344084101]