For AI agents: markdown of this page — /docs-content-en/entities/requisites/list.md documentation index — /llms.txt

List requisites

GET /v1/requisites

Returns a list of CRM requisites with support for filtering, sorting, and auto-pagination. Requisites always belong to a specific contact or company — you almost always need a filter by entityTypeId and entityId.

Parameters

Parameter Type Default Description
limit number 50 Number of records (up to 5000). When limit > 50, Vibecode automatically requests several pages from Bitrix24
offset number 0 Skip N records. When offset > 0, limit ≤ 500 is recommended
select string — Field selection: ?select=id,rqName,rqInn
order object — Sorting: ?order[sort]=asc or ?sort=-id
filter object — Filtering by GET /v1/requisites/fields fields.
Filtering syntax. Example: ?filter[entityTypeId]=4&filter[entityId]=15

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/requisites?filter[entityTypeId]=4&filter[entityId]=15" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth app

Terminal 
curl "https://vibecode.bitrix24.com/v1/requisites?filter[entityTypeId]=4&filter[entityId]=15" \
  -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?filter[entityTypeId]=4&filter[entityId]=15', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Found ${meta.total} requisites`)

JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisites?filter[entityTypeId]=4&filter[entityId]=15', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field Type Description
success boolean Always true on success
data array Array of requisites (all fields — see Requisite fields)
meta.total number Total number of records matching the filter
meta.hasMore boolean Whether there are more records beyond the limit

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": "1234567890",
      "rqKpp": "123456789",
      "rqOgrn": "1234567890123",
      "rqOkpo": "12345678",
      "rqOkved": "62.01",
      "rqCompanyName": "Acme",
      "rqCompanyFullName": "Acme Limited Liability Company",
      "rqDirector": "John Smith",
      "rqAccountant": "Anna Brown",
      "rqVatPayer": false
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

Error response example

403 — no scope:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "Requires 'crm' scope"
  }
}

Errors

HTTP Code Description
403 SCOPE_DENIED API key does not have the crm scope
401 TOKEN_MISSING API key has no configured tokens
400 INVALID_FILTER Error in the filter syntax

Full list of common API errors — Errors.

Known specifics

Schema fields — camelCase, custom — in the original case. All Vibecode schema fields, including international preset fields rqEdrpou, rqKbe, rqRegon, rqSiret, rqCnpj, are returned in camelCase. Filtering and sorting use the same name. Custom UF_CRM_* fields are returned in the original Bitrix24 case.

Empty values are normalized. Bitrix24 returns "" for cleared fields and null for never-filled ones. Vibecode converts them to null for string/number/date/datetime types — an if (v) check is enough for the client without extra conditions.

Narrow the result with an owner filter. A Bitrix24 account can have tens of thousands of requisites. To get a specific company's or contact's requisites, pass entityTypeId + entityId.

entityTypeId codes: 3 — contact, 4 — company. For smart processes and other CRM entities requisites are not supported on the Bitrix24 side.

Auto-pagination. When limit > 50, Vibecode automatically requests several pages from Bitrix24 and returns all records in one response.

Offset limit. When offset ≥ 2500, Bitrix24 may return INTERNAL_ERROR. Use limit ≤ 500 with large offsets.

See also