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

`GET /v1/categories/:entityTypeId`

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

## Параметры

| Параметр | Тип | Описание |
|----------|-----|---------|
| `entityTypeId` (path) | number | ID типа CRM-сущности. Сделки — `2`, счета — `31`, смарт-процессы — из `GET /v1/smart-processes` |
| `select` | string[] | Какие поля вернуть. По умолчанию приходят все |
| `limit` | number | Сколько воронок вернуть. По умолчанию — `50`, максимум — `5000` |
| `offset` | number | Сколько воронок пропустить с начала списка |

## Примеры

В примерах `entityTypeId = 2` (сделки) — замените на нужный тип.

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

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

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

```bash
curl -X GET https://vibecode.bitrix24.tech/v1/categories/2 \
  -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', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data } = await res.json()
console.log(`Воронок: ${data.length}`)
```

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

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

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

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив воронок типа |
| `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 | Источник внешней привязки. Пустая строка у воронок без неё |
| `meta.total` | number | Сколько воронок у типа всего — не зависит от `limit` и `offset` |
| `meta.hasMore` | boolean | Остались ли воронки за пределами текущей страницы |

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

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

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

Ответ всегда содержит `meta`. У дополнительных воронок сделок есть `originId` и `originatorId`, у основной воронки (id `0`) их нет:

```json
{
  "success": true,
  "data": [
    { "id": 1, "name": "Newest", "sort": 100, "entityTypeId": 2, "isDefault": false, "originId": "", "originatorId": "" },
    { "id": 11, "name": "English", "sort": 200, "entityTypeId": 2, "isDefault": false, "originId": "", "originatorId": "" },
    { "id": 0, "name": "Общая", "sort": 300, "entityTypeId": 2, "isDefault": true }
  ],
  "meta": { "total": 3, "hasMore": false }
}
```

У воронок смарт-процесса набор полей короче:

```json
{
  "success": true,
  "data": [
    { "id": 3, "name": "Общее", "sort": 500, "entityTypeId": 174, "isDefault": true },
    { "id": 23, "name": "Доп воронка", "sort": 510, "entityTypeId": 174, "isDefault": false }
  ],
  "meta": { "total": 2, "hasMore": false }
}
```

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

404 — тип не найден:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Смарт-процесс не найден"
  }
}
```

## Ошибки

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

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

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

**`filter` и `order` принимаются, но не действуют.** Запрос с ними возвращает `200` и тот же состав воронок в том же порядке, что и запрос без них. Сортировка идёт по полю `sort`. Отбор по названию делайте на стороне клиента: `data.filter(c => c.name === 'Продажи')`.

**Постраничный обход считает от полного списка типа.** `meta.total` показывает, сколько воронок у типа всего, и не меняется от `limit` и `offset` — обходите список, пока `meta.hasMore` не станет `false`.

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

- [Поиск воронок](/docs/entities/categories/search)
- [Получить воронку](/docs/entities/categories/get)
- [Создать воронку](/docs/entities/categories/create)
- [Поля воронки](/docs/entities/categories/fields)
- [Типы смарт-процессов](/docs/entities/smart-processes)
- [Стадии и статусы](/docs/entities/statuses)
- [Entity API](/docs/entity-api)