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

Search requisites

POST /v1/requisites/search

Search requisites with filters and auto-pagination. Similar to GET /v1/requisites, but parameters are passed in the request body — more convenient for complex filters with many conditions and for building requests programmatically.

Request fields (body)

Parameter Type Default Description
filter object — Filtering by the fields from GET /v1/requisites/fields.
Filtering syntax. Example: { "entityTypeId": 4, "entityId": 15 }
limit number 50 Number of records (up to 5000)
offset number 0 Skip N records. Combined with a date-range filter wider than 14 days, the request is rejected — see UNSTABLE_OFFSET_PAGINATION in the "Errors" section
order object — Sorting by the camelCase field name: { "name": "asc" }, { "updatedAt": "desc" }. Ordering by the identifier uses the upper-case name — { "ID": "desc" }, while the form { "id": "desc" } leaves the result set unchanged
select string[] — Field selection: ["id", "rqName", "rqInn"]
autoWindow boolean true Split the result set into weekly windows when filtering by a date range wider than 14 days. false disables splitting

Examples

curl — personal key

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/requisites/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityTypeId": 4, "active": true },
    "limit": 20,
    "order": { "sort": "asc" }
  }'

curl — OAuth app

Terminal 
curl -X POST "https://vibecode.bitrix24.com/v1/requisites/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "entityTypeId": 4, "active": true },
    "limit": 20,
    "order": { "sort": "asc" }
  }'

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisites/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityTypeId: 4, active: true },
    limit: 20,
    order: { sort: 'asc' },
  }),
})

const { success, data } = await res.json()
console.log('Found:', data.length)

JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisites/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { entityTypeId: 4, active: true },
    limit: 20,
    order: { sort: 'asc' },
  }),
})

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

Other scenarios

Search by a Russian preset field (rqInn — the tax ID):

JSON 
{ "filter": { "rqInn": "1234567890" } }

Search by a country-specific preset field (French SIRET):

JSON 
{ "filter": { "rqSiret": "73282932000074" } }

International fields rqSiret, rqSiren, rqRegon, rqKbe, rqCnpj are schema fields — filter by them in camelCase.

All requisites of one company:

JSON 
{
  "filter": { "entityTypeId": 4, "entityId": 15 },
  "order": { "sort": "asc" }
}

Response fields

Field Type Description
success boolean Always true on success
data array Array of requisites (all fields — see Requisite fields)
meta.total number How many records matched the filter
meta.hasMore boolean Whether there are more records beyond limit
meta.durationMs number Request duration in milliseconds
meta.autoWindowed boolean true if the result set was split into time windows
meta.windowCount number Number of windows. Present with autoWindowed: true
meta.batchWaves number Number of parallel request waves. Present with autoWindowed: true

The meta fields sit next to data, not inside it. Pages must be walked by meta.hasMore: a data length equal to limit does not rule out the last page.

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 42,
      "entityTypeId": 4,
      "entityId": 15,
      "presetId": 1,
      "name": "Primary requisite",
      "active": true,
      "sort": 500,
      "rqName": "Acme LLC",
      "rqInn": null,
      "rqKpp": null,
      "rqOgrn": null,
      "rqCompanyName": "Acme",
      "rqDirector": "John Smith",
      "createdAt": "2025-01-15T09:30:00+00:00"
    }
  ],
  "meta": {
    "total": 79,
    "hasMore": true,
    "durationMs": 188
  }
}

With a date-range filter wider than 14 days, meta additionally returns autoWindowed, windowCount, and batchWaves:

JSON 
{
  "success": true,
  "data": [ /* ... */ ],
  "meta": {
    "total": 174,
    "hasMore": true,
    "autoWindowed": true,
    "windowCount": 444,
    "batchWaves": 9,
    "durationMs": 20835
  }
}

Error response example

403 — no scope:

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

Errors

HTTP Code Description
403 SCOPE_DENIED The API key does not have the crm scope
401 TOKEN_MISSING The API key has no configured tokens
400 INVALID_FILTER Error in the filter syntax
400 UNSTABLE_OFFSET_PAGINATION offset greater than zero together with a date-range filter wider than 14 days. Two different retrieval algorithms produce inconsistent results, so the request is rejected. Take everything in a single request with limit up to 5000, or pass autoWindow: false with sorting by the upper-case ID, or split the date range into parts yourself
429 RATE_LIMITED Rate limit exceeded: 300 requests per minute per portal, all API keys of the portal share one limit. The exact value arrives in the x-ratelimit-limit header (the cap is divided across replicas). Retry after the delay in the Retry-After header

Full list of common API errors — Errors.

Known specifics

Time-window splitting. A date-range filter wider than 14 days is automatically split into weekly windows executed in parallel waves, so the result set bypasses the ceiling of 5000 records per call. meta then returns autoWindowed: true, the number of windows windowCount, and the number of waves batchWaves. The autoWindow: false parameter disables splitting. While splitting is active, an offset greater than zero is rejected with UNSTABLE_OFFSET_PAGINATION.

Field names in the filter. Pass Vibecode schema fields in camelCase — rqInn, rqKpp, entityTypeId, rqCompanyName, rqDirector, plus international preset fields rqEdrpou, rqKbe, rqRegon, rqSiret, rqCnpj and rare service ones rqIfns, rqUsrle. Pass custom UF_CRM_* fields in the original case.

Pagination. When limit > 50, the request is automatically split into several calls to Bitrix24. For large result sets use offset and paginated requests.

See also