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

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

GET /v1/deal-categories/:id

Возвращает воронку сделок по ID.

Параметры пути

Параметр Тип Обяз. Описание
id (path) number да ID воронки. Список: GET /v1/deal-categories

Основная воронка с id 0 через этот эндпоинт недоступна — для неё используйте /v1/categories/2/0.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/deal-categories/3" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/deal-categories/3', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Воронка со всеми полями
data.id number ID воронки
data.name string Название
data.sort number Сортировка
data.isLocked boolean Заблокирована ли воронка — недоступна на текущем тарифе
data.createdAt datetime Дата создания

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

JSON 
{
  "success": true,
  "data": {
    "id": 3,
    "name": "Корпоративные продажи",
    "sort": 200,
    "isLocked": false,
    "createdAt": "2025-06-01T14:00:00.000Z"
  }
}

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

404 — воронки с таким ID нет:

JSON 
{
  "success": false,
  "error": { "code": "ENTITY_NOT_FOUND", "message": "Not found" }
}

Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Воронка не найдена
422 BITRIX_ERROR Передан id основной воронки 0 — сообщение ID is not defined or invalid.
403 SCOPE_DENIED API-ключ не имеет скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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