#Список воронок

GET /v1/deal-categories

Возвращает список воронок сделок. Обычно содержит менее 10 записей.

#Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей
offset number 0 Пропустить N записей
select string — Выборка полей: ?select=id,name,sort
order object — Сортировка: ?order[sort]=asc
filter object — Фильтрация по полям GET /v1/deal-categories/fields.
Синтаксис фильтрации. Пример: ?filter[name]=Newest

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/deal-categories?order[sort]=asc" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/deal-categories?order[sort]=asc" \
  -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?order[sort]=asc', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data, meta } = await res.json()

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

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

#Поля ответа

Поле Тип Описание
data[].id number ID воронки
data[].name string Название
data[].sort number Сортировка
data[].isLocked string Заблокирована (Y/N)
data[].createdAt datetime Дата создания

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 0,
      "name": "Общая",
      "sort": 100,
      "isLocked": "N",
      "createdAt": "2025-01-15T10:30:00+03:00"
    },
    {
      "id": 3,
      "name": "Корпоративные продажи",
      "sort": 200,
      "isLocked": "N",
      "createdAt": "2025-06-01T14:00:00+03:00"
    }
  ],
  "meta": { "total": 2, "hasMore": false }
}

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

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

#Ошибки

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

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

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