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

GET /v1/smart-processes

Возвращает все типы смарт-процессов на портале. Каждый тип имеет entityTypeId — используйте его для работы с элементами через /v1/items/:entityTypeId.

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/smart-processes" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/smart-processes" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/smart-processes', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
for (const sp of data) {
  console.log(`${sp.title}: entityTypeId=${sp.entityTypeId}`)
}

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/smart-processes', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

#Поля ответа

Поле Тип Описание
data[].id number ID типа
data[].entityTypeId number ID типа сущности — передавать в /v1/items/:entityTypeId
data[].title string Название
data[].isCategoriesEnabled boolean Воронки включены
data[].isStagesEnabled boolean Стадии включены
data[].isClientEnabled boolean Поля клиента (контакт/компания)
data[].isLinkWithProductsEnabled boolean Товарные позиции
data[].isObserversEnabled boolean Наблюдатели
data[].isSourceEnabled boolean Источник
data[].isAutomationEnabled boolean Автоматизация
data[].isBizProcEnabled boolean Бизнес-процессы
data[].createdBy number Создатель. Поиск: GET /v1/users
data[].createdTime datetime Дата создания
data[].updatedTime datetime Дата изменения

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 3,
      "title": "Договоры",
      "entityTypeId": 174,
      "isCategoriesEnabled": true,
      "isStagesEnabled": true,
      "isClientEnabled": true,
      "isLinkWithProductsEnabled": true,
      "isObserversEnabled": true,
      "isSourceEnabled": true,
      "isAutomationEnabled": true,
      "isBizProcEnabled": true,
      "createdBy": 1,
      "createdTime": "2021-07-20T16:04:10+03:00",
      "updatedTime": "2024-07-19T14:27:27+03:00"
    }
  ]
}

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

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

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

#Ошибки

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

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

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

entityTypeId: это ключевое поле — передавайте его в /v1/items/{entityTypeId} для работы с элементами этого типа.

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