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
Parameterlimit Typenumber Default50 DescriptionNumber of records (up to 5000). When limit > 50, Vibecode automatically requests several pages from Bitrix24
Parameteroffset Typenumber Default0 DescriptionSkip N records. When offset > 0, limit ≤ 500 is recommended
Parameterselect Typestring Default— DescriptionField selection: ?select=id,rqName,rqInn
Parameterorder Typeobject Default— DescriptionSorting by the camelCase field name: ?order[name]=asc, ?order[updatedAt]=desc, ?order[presetId]=desc. The short form is ?sort=-updatedAt, where the minus means descending. For the identifier, use ?order[id]=desc or ?sort=-id; the ID form is accepted too
Parameterfilter Typeobject Default— DescriptionFiltering by the fields from GET /v1/requisites/fields.
Filtering syntax. Example: ?filter[entityTypeId]=4&filter[entityId]=15

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl -g "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 application

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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of requisites (all fields — see Requisite fields)
Fieldmeta.total Typenumber DescriptionTotal number of records matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether 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": null,
      "rqKpp": null,
      "rqOgrn": null,
      "rqOkpo": null,
      "rqOkved": null,
      "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
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens
HTTP400 CodeINVALID_FILTER DescriptionError in the filter syntax
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the x-ratelimit-limit header. Retry after the delay in the Retry-After header

For the full list of common API errors, see Errors.

Known specifics

Schema fields are camelCase, custom fields keep their 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, including id; the ID variant is accepted too. 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 — the client needs only an if (v) check, with no extra conditions.

Narrow the result set 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.

There is no id cursor here. The meta.nextAfterId field is not returned in the response: pages are fetched by offset, and meta.hasMore tells you when to stop. Bulk reading therefore relies on narrowing the result set — a filter by owner or by requisite fields.

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

See also