Получить воронку

GET /v1/categories/:entityTypeId/:id

Возвращает одну воронку по ID в рамках указанного типа CRM-сущности.

Параметры

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

Примеры

В примерах entityTypeId = 2, id = 1 — замените на ваши значения.

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

Terminal 
curl -X GET https://vibecode.bitrix24.tech/v1/categories/2/1 \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X GET https://vibecode.bitrix24.tech/v1/categories/2/1 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

const { success, data } = await res.json()
console.log('Воронка:', data.name)

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

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number ID воронки. Для сделок основная воронка имеет id 0
data.name string Название воронки
data.sort number Порядок сортировки
data.entityTypeId number ID типа CRM-сущности, повторяет параметр пути
data.isDefault boolean Признак основной воронки типа
data.originId string Внешний идентификатор. Пустая строка у воронок без внешней привязки
data.originatorId string Источник внешней привязки. Пустая строка у воронок без неё

Для основной воронки сделок (id 0) поля originId и originatorId в ответе отсутствуют.

Стадии воронки запрашиваются отдельно: GET /v1/statuses?filter[entityId]=DEAL_STAGE_{id}.

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

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "name": "Newest",
    "sort": 100,
    "entityTypeId": 2,
    "isDefault": false,
    "originId": "",
    "originatorId": ""
  }
}

Основная воронка сделок (id 0) приходит без originId и originatorId:

JSON 
{
  "success": true,
  "data": {
    "id": 0,
    "name": "Общая",
    "sort": 300,
    "entityTypeId": 2,
    "isDefault": true
  }
}

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

404 — воронка не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Элемент не найден"
  }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Воронки с указанным id нет в этом типе
404 ENTITY_NOT_FOUND entityTypeId не соответствует существующему типу CRM
422 BITRIX_ERROR Тип CRM не поддерживает воронки. Предложения 7 воронок не имеют
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 TOKEN_MISSING API-ключ не имеет настроенных токенов

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

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