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

Поиск связей реквизитов

POST /v1/requisite-links/search

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

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

Параметр Тип По умолч. Описание
filter object — Фильтрация. Допустимые ключи: entityTypeId, entityId, requisiteId, bankDetailId, mcRequisiteId, mcBankDetailId. Поддерживаются операторы сравнения ($gt/$gte/$lt/$lte), множества ($in/$nin). Логические $or/$and не поддерживаются.
Синтаксис фильтрации. Пример: { "entityTypeId": 2, "entityId": 3773 }
sort string — Поле сортировки — один из ключей фильтра
order string | object asc Направление для sort (asc/desc), либо форма { "поле": "asc|desc" }
limit number 50 Количество записей, до 5000
offset number 0 Пропустить N записей

Примеры

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

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

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

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

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

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

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

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

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

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

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

Блоки ниже — тела запросов.

Все связи по конкретной сделке:

JSON 
{ "filter": { "entityTypeId": 2, "entityId": 3773 } }

Все связи по конкретному реквизиту — к каким сущностям привязан реквизит с ID 45:

JSON 
{ "filter": { "requisiteId": 45 } }

Только сделки, у которых реквизит клиента действительно привязан:

JSON 
{
  "filter": { "entityTypeId": 2, "requisiteId": { "$gt": 0 } },
  "limit": 100
}

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив связей
data[].entityTypeId number Тип владельца. Значения — Поля связи
data[].entityId number ID владельца
data[].requisiteId number ID реквизита клиента, 0 — не привязан. Источник: GET /v1/requisites
data[].bankDetailId number ID банковского реквизита клиента, 0 — не привязан. Источник: GET /v1/bank-details
data[].mcRequisiteId number ID реквизита вашей компании, 0 — не привязан
data[].mcBankDetailId number ID банковского реквизита вашей компании, 0 — не привязан
meta.total number Сколько записей подошло под фильтр
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

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

JSON 
{
  "success": true,
  "data": [
    {
      "entityTypeId": 2,
      "entityId": 3773,
      "requisiteId": 45,
      "bankDetailId": 0,
      "mcRequisiteId": 0,
      "mcBankDetailId": 0
    },
    {
      "entityTypeId": 2,
      "entityId": 3913,
      "requisiteId": 225,
      "bankDetailId": 0,
      "mcRequisiteId": 0,
      "mcBankDetailId": 0
    }
  ],
  "meta": {
    "total": 40,
    "hasMore": true
  }
}

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

400 — логический оператор верхнего уровня:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_FILTER_OPERATOR",
    "message": "'$or' is not supported. OR/AND logic cannot be expressed in a single requisite-links filter. For same-field set membership use { field: { $in: [v1, v2] } }; for cross-field OR run parallel requests. AND is the default — combine conditions as sibling keys in one filter object."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_FILTER_OPERATOR Логический оператор верхнего уровня $or или $and
400 MISSING_ENTITY_TYPE_ID Фильтр по entityId без entityTypeId
400 UNKNOWN_FILTER_FIELD Неизвестное поле фильтра, в сообщении — список допустимых
400 UNKNOWN_SORT_FIELD Неизвестное поле сортировки, в сообщении — список допустимых
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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

Связь в выдаче не означает наличия привязки. Строка со всеми четырьмя идентификаторами, равными 0, — это заведённая связь без единой привязки. Чтобы отобрать только реальные привязки, добавьте условие { "requisiteId": { "$gt": 0 } }.

Набор одного поля вместо $or. Несколько значений одного поля задаются через $in — например { "entityTypeId": { "$in": [2, 31] } }. Условия по разным полям в одном фильтре объединяются по «и».

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