Для AI-агентов: markdown этой страницы — /docs-content/entities/requisite-presets/search.md индекс документации — /llms.txt

Поиск шаблонов реквизитов

POST /v1/requisite-presets/search

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

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

Параметр Тип По умолч. Описание
filter object — Фильтрация по полям GET /v1/requisite-presets/fields.
Синтаксис фильтрации. Пример: { "active": true, "countryId": 1 }
limit number 50 Количество записей (до 5000)
offset number 0 Пропустить N записей. Вместе с фильтром по диапазону дат шире 14 дней отклоняется — см. UNSTABLE_OFFSET_PAGINATION в разделе «Ошибки»
order object — Сортировка: { "sort": "asc" }, { "name": "desc" }. Порядок по идентификатору задаётся именем в верхнем регистре — { "ID": "desc" }, форма { "id": "desc" } выборку не меняет
select string[] — Выборка полей: ["id", "name", "active", "countryId"]
autoWindow boolean true Разбивать выборку по недельным окнам при фильтре по диапазону дат шире 14 дней. false отключает разбиение

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/requisite-presets/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "active": true },
    "limit": 20
  }'

curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/requisite-presets/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "active": true },
    "limit": 20
  }'

JavaScript — личный ключ

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

const { success, data, meta } = await res.json()
console.log('Найдено:', meta.total)

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

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

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

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

Найти шаблоны по стране:

JSON 
{ "filter": { "countryId": 1 }, "order": { "sort": "asc" } }

Только активные шаблоны, выбрать только id и name:

JSON 
{
  "filter": { "active": true },
  "select": ["id", "name"],
  "order": { "sort": "asc" }
}

Найти шаблон по xmlId:

JSON 
{ "filter": { "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#" } }

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив шаблонов (все поля — см. Поля шаблонов реквизитов)
meta.total number Сколько записей подошло под фильтр
meta.hasMore boolean Есть ли ещё записи за пределами limit
meta.durationMs number Длительность запроса в миллисекундах
meta.autoWindowed boolean true, если выборка была разбита по временны́м окнам
meta.windowCount number Число окон. Приходит при autoWindowed: true
meta.batchWaves number Число волн параллельных запросов. Приходит при autoWindowed: true

Поля meta лежат рядом с data, а не внутри него. Обходить страницы нужно по meta.hasMore: длина data, равная limit, последней страницы не исключает.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "entityTypeId": 8,
      "countryId": 1,
      "name": "Организация",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-08-13T14:34:26.000Z",
      "createdBy": 0,
      "modifyBy": 1,
      "active": true,
      "sort": 510,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#"
    },
    {
      "id": 5,
      "entityTypeId": 8,
      "countryId": 1,
      "name": "Физ. лицо",
      "createdAt": "2020-04-20T10:47:23.000Z",
      "updatedAt": "2021-08-13T14:34:34.000Z",
      "createdBy": 0,
      "modifyBy": null,
      "active": true,
      "sort": 530,
      "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_PERSON#"
    }
  ],
  "meta": {
    "total": 13,
    "hasMore": false,
    "durationMs": 224
  }
}

С фильтром по диапазону дат шире 14 дней в meta дополнительно приходят autoWindowed, windowCount и batchWaves:

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

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
400 INVALID_FILTER Ошибка в синтаксисе фильтра
400 UNSTABLE_OFFSET_PAGINATION offset больше нуля вместе с фильтром по диапазону дат шире 14 дней. Два разных алгоритма выдачи дают несогласованные результаты, поэтому запрос отклоняется. Возьмите всё одним запросом с limit до 5000, либо передайте autoWindow: false с сортировкой по ID в верхнем регистре, либо режьте диапазон дат на части сами
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

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

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

Разбиение по временны́м окнам. Фильтр по диапазону дат шире 14 дней автоматически разбивается на недельные окна, которые выполняются параллельными волнами — так выборка обходит потолок в 5000 записей на один вызов. В meta тогда приходят autoWindowed: true, число окон windowCount и число волн batchWaves. Отключает разбиение параметр autoWindow: false. При активном разбиении offset больше нуля отклоняется с UNSTABLE_OFFSET_PAGINATION.

Поле xmlId — стабильный идентификатор встроенных шаблонов. Встроенные российские шаблоны имеют константные значения xmlId: #CRM_REQUISITE_PRESET_DEF_RU_COMPANY#, #CRM_REQUISITE_PRESET_DEF_RU_INDIVIDUAL#, #CRM_REQUISITE_PRESET_DEF_RU_PERSON#. Поиск по xmlId надёжнее поиска по id, который может различаться между порталами.

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

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