## Get requisite

`GET /v1/requisites/:id`

Returns a requisite by ID with all fields available in its preset — the preset defines the field set: company name, tax identifiers, director, accountant and so on.

## Parameters

| Parameter | Type | Required | Description |
|----------|-----|:-----:|---------|
| `id` (path) | number | yes | Requisite ID |
| `include` (query) | string | no | Related data: `preset`. See the "Related data" section below |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/requisites/42" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/requisites/42" \
  -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/requisites/42', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Requisite:', data.rqName, '— company', data.rqCompanyName)
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/requisites/42', {
  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 | Requisite object |
| `data.id` | number | Requisite identifier |
| `data.entityTypeId` | number | Parent entity type: `3` — contact, `4` — company |
| `data.entityId` | number | Parent entity ID |
| `data.presetId` | number | ID of the [requisite preset](/docs/entities/requisite-presets) |
| `data.name` | string | Requisite name in the interface |
| `data.active` | boolean | Whether the requisite is active |
| `data.sort` | number | Sort order |
| `data.createdAt` / `data.updatedAt` | datetime | Creation and modification dates (ISO 8601) |
| `data.createdBy` / `data.modifyBy` | number \| null | Creator / last editor ID |
| `data.rqName` / `data.rqInn` / `data.rqKpp` / `data.rqOgrn` | string \| null | Core legal-entity requisites |

Preset fields that are not filled in are returned as `null`. Full list of fields — [Requisite fields](/docs/entities/requisites/fields).

## Related data

To retrieve a related record together with the requisite, use the `include` query parameter:

```
GET /v1/requisites/1?include=preset
```

Available include: `preset` — the requisite preset that defines the field set. The result is in the `_included` field:

```json
{
  "success": true,
  "data": {
    "id": 1,
    "presetId": 1,
    "_included": {
      "preset": {
        "id": 1,
        "entityTypeId": 8,
        "countryId": 122,
        "name": "Company",
        "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#",
        "active": true,
        "sort": 510
      }
    }
  }
}
```

More on includes: [Related data](/docs/includes).

## Response example

```json
{
  "success": true,
  "data": {
    "id": 42,
    "entityTypeId": 4,
    "entityId": 15,
    "presetId": 1,
    "name": "Primary requisite",
    "active": true,
    "sort": 500,
    "code": null,
    "xmlId": null,
    "addressOnly": false,
    "createdAt": "2025-01-15T09:30:00+00:00",
    "updatedAt": "2026-03-20T14:00:00+00:00",
    "createdBy": 1,
    "modifyBy": 1,
    "rqName": "Acme LLC",
    "rqInn": null,
    "rqKpp": null,
    "rqOgrn": null,
    "rqOkpo": null,
    "rqOkved": null,
    "rqOktmo": null,
    "rqVatPayer": false,
    "rqCompanyName": "Acme",
    "rqCompanyFullName": "Acme Limited Liability Company",
    "rqDirector": "John Smith",
    "rqAccountant": "Anna Brown",
    "rqCeoName": null,
    "rqCeoWorkPos": null,
    "rqContact": null,
    "rqEmail": null,
    "rqPhone": null,
    "rqBaseDoc": "Charter"
  }
}
```

## Error response example

404 — requisite not found:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The Requisite with ID '999999999' is not found"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 404 | `ENTITY_NOT_FOUND` | No requisite found with this ID |
| 400 | `INVALID_INCLUDE` | `include` carries a name the requisite does not have. The message lists the available ones |
| 403 | `BITRIX_ACCESS_DENIED` | No access to the parent entity (contact/company) |
| 403 | `SCOPE_DENIED` | API key does not have the `crm` scope |
| 401 | `TOKEN_MISSING` | API key has no configured tokens |

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

## Known specifics

**The field set depends on the preset.** A requisite stores only the fields defined in its preset (`presetId`). Which presets exist, and which fields each one carries, depends on the country of the Bitrix24 account: a `Company` preset carries company details such as `rqCompanyName`, `rqCompanyFullName` and `rqVatId`, while a `Person` preset carries personal name fields. Fields the preset does not define come back as `null`. Check the preset's field list for the exact set.

**Custom fields — in the original case.** Vibecode schema fields are returned in camelCase, while custom `UF_CRM_*` fields are returned in the original Bitrix24 case.

## See also

- [Requisite fields](/docs/entities/requisites/fields)
- [Update requisite](/docs/entities/requisites/update)
- [Delete requisite](/docs/entities/requisites/delete)
- [List requisites](/docs/entities/requisites/list)
- [Limits and optimization](/docs/optimization)