## Get an inventory document

`GET /v1/catalog-documents/:id`

Returns one inventory document by ID. Use it to check the document state before changing it, conducting it or canceling conducting.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Document ID. List: [`GET /v1/catalog-documents`](/docs/entities/catalog-documents/list) |
| `select` (query) | string | no | Comma-separated fields in the response: `?select=id,title,status`. Field names are listed in [`GET /v1/catalog-documents/fields`](/docs/entities/catalog-documents/fields) |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/catalog-documents/299" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/catalog-documents/299" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-documents/299', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Document:', data.title, '— conducted:', data.status === 'Y')
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-documents/299', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | object | Inventory document (all fields — see [Inventory document fields](/docs/entities/catalog-documents/fields)) |
| `meta.warnings` | array | Request warnings. Returned when `select` contains a name that is not among the document fields: code `UNKNOWN_SELECT_FIELD`, the name in the `field` field. The other fields are returned |

The document's products and warehouses are not included in the response — the [item list](/docs/entities/catalog-document-elements/list) with `filter[docId]` returns them.

## Response example

```json
{
  "success": true,
  "data": {
    "commentary": null,
    "createdBy": 1,
    "currency": "USD",
    "dateCreate": "2026-10-12T13:20:16.000Z",
    "dateDocument": null,
    "dateModify": "2026-10-12T13:20:16.000Z",
    "dateStatus": "2026-10-12T13:20:16.000Z",
    "docNumber": null,
    "docType": "S",
    "id": 299,
    "modifiedBy": 1,
    "responsibleId": 1,
    "siteId": "s1",
    "status": "N",
    "statusBy": null,
    "title": "Stock adjustment — documentation check",
    "total": null
  }
}
```

## Error response example

404 — no document with this `id`:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "catalogDocument 999999999 not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | No document with this `id` on the portal, including after deletion |
| 400 | `INVALID_PARAMS` | `id` is not a non-negative integer, for example `/v1/catalog-documents/abc` |
| 403 | `SCOPE_DENIED` | The API key does not have the `catalog` scope |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `INVALID_API_KEY` | The API key passed was not found |
| 401 | `TOKEN_MISSING` | The API key has no configured tokens |

Full list of common API errors — [Errors](/docs/errors).

## See also

- [List inventory documents](/docs/entities/catalog-documents/list)
- [Update an inventory document](/docs/entities/catalog-documents/update)
- [Conduct a document](/docs/entities/catalog-documents/conduct)
- [Cancel conducting](/docs/entities/catalog-documents/cancel)
- [List document items](/docs/entities/catalog-document-elements/list)
- [Inventory documents](/docs/entities/catalog-documents)