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

Поиск воронок

POST /v1/categories/:entityTypeId/search

Возвращает воронки указанного типа CRM-сущности по телу запроса, а не по строке запроса.

Тот же набор воронок отдаёт GET /v1/categories/:entityTypeId.

Параметры

Параметр Тип Обяз. Описание
entityTypeId (path) number да Идентификатор типа CRM-сущности. Сделки — 2, счета — 31, смарт-процессы — значение из GET /v1/smart-processes

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

Поле Тип Обяз. По умолч. Описание
limit number нет 50 Количество записей, до 5000
offset number нет — Сколько воронок пропустить с начала списка
select string[] нет — Выборка полей: ["id", "name", "sort"]

Примеры

В примерах entityTypeId равен 2 — это сделки. Подставьте нужный тип.

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/categories/2/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "limit": 5 }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/categories/2/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "limit": 5 }'

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

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

const { success, data, meta } = await res.json()
console.log(`Воронок в типе: ${meta.total}`)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив воронок типа
data[].id number Идентификатор воронки. У основной воронки сделок он равен 0
data[].name string Название воронки
data[].sort number Порядок сортировки
data[].entityTypeId number Идентификатор типа CRM-сущности, повторяет сегмент пути
data[].isDefault boolean Признак основной воронки типа
data[].originId string Внешний идентификатор. Пустая строка у воронок без внешней привязки
data[].originatorId string Источник внешней привязки. Пустая строка у воронок без неё
meta.total number Количество воронок типа
meta.hasMore boolean Есть ли ещё воронки за пределами limit
meta.durationMs number Длительность запроса в миллисекундах

У основной воронки ключи originId и originatorId в ответе отсутствуют — проверяйте наличие ключа перед чтением.

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

JSON 
{
  "success": true,
  "data": [
    { "id": 1, "name": "Newest", "sort": 100, "entityTypeId": 2, "isDefault": false, "originId": "", "originatorId": "" },
    { "id": 11, "name": "English", "sort": 200, "entityTypeId": 2, "isDefault": false, "originId": "", "originatorId": "" },
    { "id": 0, "name": "Общая", "sort": 300, "entityTypeId": 2, "isDefault": true },
    { "id": 3, "name": "Партнёры", "sort": 400, "entityTypeId": 2, "isDefault": false, "originId": "", "originatorId": "" },
    { "id": 9, "name": "Тендеры", "sort": 500, "entityTypeId": 2, "isDefault": false, "originId": "", "originatorId": "" }
  ],
  "meta": {
    "total": 8,
    "hasMore": true,
    "durationMs": 1847
  }
}

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

404 — типа CRM с таким entityTypeId нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Смарт-процесс не найден"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_DYNAMIC_PARAM entityTypeId в пути не является положительным целым числом
404 ENTITY_NOT_FOUND entityTypeId не соответствует существующему типу CRM
422 BITRIX_ERROR Тип CRM не поддерживает воронки. У предложений 7 воронок нет
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING У API-ключа нет настроенных токенов

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

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

Внутри типа выборка не сужается. Единственное условие отбора — сегмент пути entityTypeId. Поля filter и order принимаются без ошибки, но не действуют: запрос с ними отдаёт тот же состав воронок в том же порядке, что и запрос без них. Нужную воронку ищите в полученном массиве по name или id, а одну известную воронку целиком отдаёт GET /v1/categories/:entityTypeId/:id.

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