## Список типов смарт-процессов

`GET /v1/smart-processes`

Возвращает типы смарт-процессов на портале. Каждый тип имеет `entityTypeId` — используйте его для работы с элементами через [/v1/items/:entityTypeId](/docs/entities/items).

## Параметры

| Параметр | Тип | По умолч. | Описание |
|----------|-----|-----------|---------|
| `filter` | object | — | Фильтрация по полям. Пример: `?filter[isStagesEnabled]=true`. [Синтаксис фильтрации](/docs/filtering) |
| `select` | string | — | Выборка полей: `?select=id,title,entityTypeId` |
| `sort` | string | — | Сортировка по полю: `?sort=title` (по возрастанию), `?sort=-createdTime` (по убыванию) |
| `limit` | number | — | Ограничить количество записей в ответе |

Список полей для `filter` и `select` — [Поля типа](/docs/entities/smart-processes/fields).

Для нескольких условий фильтрации одновременно используйте [Поиск типов](/docs/entities/smart-processes/search) — POST с телом запроса вместо строки запроса.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/smart-processes" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/smart-processes" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

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

const { success, data } = await res.json()
for (const sp of data) {
  console.log(`${sp.title}: entityTypeId=${sp.entityTypeId}`)
}
```

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

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

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

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

| Поле | Тип | Описание |
|------|-----|---------|
| `data` | array | Массив типов смарт-процессов. Поля каждого типа — см. [Поля типа](/docs/entities/smart-processes/fields) |

Список элементов любого типа из массива `data` открывается в Битрикс24 по `entityTypeId`:

```
https://<portal>.bitrix24.ru/crm/type/<entityTypeId>/list/category/0/
```

`0` — основная воронка. `<portal>` — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

```json
{
  "success": true,
  "data": [
    {
      "id": 3,
      "entityTypeId": 174,
      "title": "Договоры",
      "code": null,
      "customSectionId": null,
      "isCategoriesEnabled": true,
      "isStagesEnabled": true,
      "isClientEnabled": true,
      "isLinkWithProductsEnabled": true,
      "isObserversEnabled": true,
      "isSourceEnabled": true,
      "isAutomationEnabled": true,
      "isBizProcEnabled": true,
      "isDocumentsEnabled": true,
      "isRecyclebinEnabled": true,
      "isSetOpenPermissions": true,
      "isUseInUserfieldEnabled": true,
      "createdBy": 1,
      "updatedBy": 1,
      "createdTime": "2021-07-20T16:04:10+03:00",
      "updatedTime": "2024-07-19T14:27:27+03:00"
    }
  ]
}
```

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

403 — нет скоупа:

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

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 401 | `MISSING_API_KEY` | Заголовок `X-Api-Key` не передан |
| 401 | `INVALID_API_KEY` | Ключ не найден или отозван |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 422 | `BITRIX_ERROR` | Ошибка от Битрикс24. Конкретная причина — в поле `message` |

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

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

**`entityTypeId` — ключевое поле.** Сохраняйте его и передавайте в `/v1/items/:entityTypeId` для работы с элементами этого типа.

**Пагинации нет.** Ответ содержит все типы смарт-процессов портала одним массивом.

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

- [Создать тип](/docs/entities/smart-processes/create)
- [Получить тип](/docs/entities/smart-processes/get)
- [Поля типа](/docs/entities/smart-processes/fields)
- [Поиск типов](/docs/entities/smart-processes/search)
- [Элементы смарт-процессов](/docs/entities/items)
- [Синтаксис фильтрации](/docs/filtering)
- [Лимиты и оптимизация](/docs/optimization)