# Personal signed documents

`GET /v1/sign-b2e/personal-documents`

Returns the signed documents of the current user. Requires OAuth authorization. Credential-bearing links are replaced with a safe marker.

**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`.

## Query parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| `limit` | integer \| string | no | Defaults to 20; from 1 to 1000. Bitrix24 replaces an invalid value with 20. |
| `offset` | integer \| string | no | Offset from the start of the list; 0 by default. |

## Examples

### curl — OAuth application

```bash
curl -X GET 'https://vibecode.bitrix24.com/v1/sign-b2e/personal-documents' \
  -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/personal-documents', {
  "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 |
|---|---|---|
| `success` | boolean | Whether the request succeeded. |
| `data` | array<object> | Operation data. |
| `data[].id` | integer | Object ID. |
| `data[].title` | string | Object name. |
| `data[].signed_date` | string \| null | Signing date in ATOM format. |
| `data[].file_url` | string | File URL; replaced with [REDACTED] if it contains credentials. |
| `meta.redacted` | array<string> | Present 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": []
}
```

## 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 |
|---|---|---|
| 400 | `INVALID_PARAMS` | Invalid request shape: types, required fields or an unknown query string parameter. |
| 401 | `TOKEN_MISSING` | No credentials for the Bitrix24 connection. |
| 403 | `SCOPE_DENIED` | One of the required scopes is not granted. |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the operation; the code is in error.b24Code, the text in error.message. |
| 422 | `BITRIX_ERROR` | An incoming webhook was used instead of OAuth. The native `WRONG_AUTH_TYPE` code is in `error.b24Code`. |

[Common API errors](/docs/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 default page size is 20, the maximum is 1000. An invalid limit is replaced with 20, an invalid offset with 0. Bitrix24 applies these rules.

## See also

- [Employee signatures](/docs/sign-b2e)
- [API errors](/docs/errors)
