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

`GET /v1/deal-categories`

Возвращает список воронок сделок портала с поддержкой сортировки и пагинации.

Основная воронка с id `0` в список не входит — она доступна через `/v1/categories/2`.

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Количество записей |
| `offset` | number | `0` | Пропустить N записей |
| `select` | string | — | Выборка полей: `?select=id,name,sort` |
| `order` | object | — | Сортировка: `?order[sort]=asc` |
| `filter` | object | — | Только точное равенство и `$in` (IN-множество) по полям `id`, `name`, `sort`. Операторы (`>`, `>=`, `<`, `<=`, `!`, `%`, `$ne`, `$contains`, `$nin`) и фильтрация по `isLocked` / `createdAt` не поддерживаются — вернётся `400 UNSUPPORTED_FILTER`.<br>[Синтаксис фильтрации](/docs/filtering). Пример: `?filter[name]=Newest` |

## Примеры

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

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

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

```bash
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` | boolean | Заблокирована ли воронка — недоступна на текущем тарифе |
| `data[].createdAt` | datetime | Дата создания |

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

```json
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Продажи",
      "sort": 100,
      "isLocked": false,
      "createdAt": "2025-01-15T10:30:00.000Z"
    },
    {
      "id": 3,
      "name": "Корпоративные продажи",
      "sort": 200,
      "isLocked": false,
      "createdAt": "2025-06-01T14:00:00.000Z"
    }
  ],
  "meta": { "total": 2, "hasMore": false }
}
```


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

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `UNSUPPORTED_FILTER` | Оператор или неподдерживаемое поле в фильтре. Фильтруйте точным равенством или `$in` по `id`, `name`, `sort` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | Не передан API-ключ |

Полный список ошибок — [Ошибки](/docs/errors).

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

**Только точное равенство в фильтре.** Фильтр применяется точным равенством (и `$in`-множеством) по `id`, `name`, `sort`. Операторы (`>`, `<`, `!`, `%`), `$ne`/`$contains`/`$nin` и фильтрация по `isLocked` / `createdAt` дают `400 UNSUPPORTED_FILTER` — так вы сразу видите, что фильтр не применился, а не получаете весь список без фильтра. `isLocked` в Битрикс24 — переключатель видимости выборки, а не поле для равенства: значение `Y` возвращает все воронки, `N` — все кроме заблокированных. В ответе это поле приходит булевым. Сортировка `order` по `sort` при этом работает.

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

- [Воронки сделок](/docs/entities/deal-categories)
- [Создать воронку](/docs/entities/deal-categories/create)
- [Сделки](/docs/entities/deals)
- [Batch](/docs/batch)