Поиск типов смарт-процессов

POST /v1/smart-processes/search

Поиск типов смарт-процессов с фильтрами в теле POST-запроса. Применяется, когда условий фильтрации несколько и они не помещаются в строку запроса.

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

Параметр Тип По умолч. Описание
filter object {} Фильтрация по любым полям типа (title, entityTypeId, isStagesEnabled, isClientEnabled, isAutomationEnabled и т. д.). Синтаксис фильтрации
limit number 50 Количество записей в ответе

Полный список полей, по которым можно фильтровать: Поля типа.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/smart-processes/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "isClientEnabled": true, "isStagesEnabled": true },
    "limit": 10
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/smart-processes/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "isClientEnabled": true, "isStagesEnabled": true },
    "limit": 10
  }'

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

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

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

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

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

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

Поля ответа

Поле Тип Описание
data array Массив типов, удовлетворяющих фильтру. Поля каждого типа — см. Поля типа
meta.total number Общее количество типов под фильтр
meta.hasMore boolean Есть ли ещё записи сверх limit
meta.durationMs number Время выполнения запроса в миллисекундах

Список элементов любого типа из массива data открывается в Битрикс24 по entityTypeId:

https://<portal>.bitrix24.ru/crm/type/<entityTypeId>/list/category/0/

0 — основная воронка. <portal> — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3,
      "entityTypeId": 174,
      "title": "Договоры",
      "isStagesEnabled": true,
      "isClientEnabled": true,
      "isCategoriesEnabled": true,
      "isLinkWithProductsEnabled": true
    }
  ],
  "meta": { "total": 7, "hasMore": false, "durationMs": 884 }
}

В каждом объекте показаны 7 полей. Полный ответ содержит все поля типа.

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

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

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

Ошибки

HTTP Код Описание
401 MISSING_API_KEY Заголовок X-Api-Key не передан
401 INVALID_API_KEY Ключ не найден или отозван
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов
422 BITRIX_ERROR Ошибка от Битрикс24. Конкретная причина — в поле message

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

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

Булевы фильтры передавайте как true/false, не как "Y"/"N" — Вайбкод сам преобразует их для Битрикс24.

Когда использовать search вместо list. Когда нужно несколько условий фильтрации одновременно — тело запроса читаемее длинной строки запроса. Для получения всех типов подойдёт GET /v1/smart-processes.

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