#Поиск реквизитов

POST /v1/requisites/search

Поиск реквизитов с фильтрами и авто-пагинацией. Аналогичен GET /v1/requisites, но параметры передаются в теле запроса — удобнее для сложных фильтров с большим количеством условий и для программной сборки запросов.

#Поля запроса (body)

Параметр Тип По умолч. Описание
filter object — Фильтрация по полям GET /v1/requisites/fields.
Синтаксис фильтрации. Пример: { "entityTypeId": 4, "entityId": 15 }
limit number 50 Количество записей (до 5000)
offset number 0 Пропустить N записей
order object — Сортировка: { "sort": "asc" }
select string[] — Выборка полей: ["id", "rqName", "rqInn"]

#Примеры

#curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/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-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/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 — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/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('Найдено:', data.length)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/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()

#Другие сценарии

Поиск по ИНН:

JSON 
{ "filter": { "rqInn": "7701234567" } }

Поиск по полю вне схемы (французский SIRET):

JSON 
{ "filter": { "RQ_SIRET": "73282932000074" } }

Международные поля (RQ_SIRET, RQ_SIREN, RQ_REGON, RQ_KBE, RQ_CNPJ) не входят в Вайбкод-схему — используйте их исходные UPPER_SNAKE_CASE-имена.

Все реквизиты одной компании:

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив реквизитов (все поля — см. Поля реквизита)

#Пример ответа

JSON 
{
  "success": true,
  "data": [
    {
      "id": 42,
      "entityTypeId": 4,
      "entityId": 15,
      "presetId": 1,
      "name": "Основной реквизит",
      "active": true,
      "sort": 500,
      "rqName": "ООО «Ромашка»",
      "rqInn": "7701234567",
      "rqKpp": "770101001",
      "rqOgrn": "1027700123456",
      "rqCompanyName": "Ромашка",
      "rqDirector": "Иванов Иван Иванович",
      "createdAt": "2025-01-15T09:30:00+03:00"
    }
  ]
}

#Пример ответа при ошибке

403 — нет скоупа:

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

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
400 INVALID_FILTER Ошибка в синтаксисе фильтра

Полный список общих ошибок API — Ошибки.

#Известные особенности

Имена полей в фильтре. 60 полей из Вайбкод-схемы передавайте в camelCase (rqInn, rqKpp, entityTypeId, rqCompanyName, rqDirector, rqOkpo). Поля международных пресетов (RQ_EDRPOU, RQ_KBE, RQ_REGON, RQ_SIRET, RQ_CNPJ) и редкие служебные (RQ_USRLE, RQ_IFNS, UF_CRM_*) — в UPPER_SNAKE_CASE.

Пагинация. При limit > 50 запрос автоматически разбивается на несколько вызовов к Битрикс24. Для больших выборок используйте offset и постраничные запросы.

#Смотрите также