## Список сценариев

`GET /v1/crm-forms/scenarios`

Возвращает сценарии конструктора CRM-форм — заготовки форм для обратного звонка, онлайн-записи, продажи товаров, регистрации на мероприятие и других задач.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/crm-forms/scenarios" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

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

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

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

const { success, data } = await res.json()
console.log(data.map(scenario => `${scenario.id} — ${scenario.title}`))
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/scenarios', {
  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` | string | Идентификатор сценария, например `contacts`, `callback` |
| `data[].title` | string | Название сценария |
| `data[].description` | string | Описание сценария |
| `data[].categoryId` | string | Категория сценария. Список: [Категории сценариев](/docs/entities/crm-forms/scenario-categories) |
| `data[].iconUrl` | string | Путь к значку сценария от корня адреса Битрикс24, например `/bitrix/images/crm/webform/icons/contacts.svg` |
| `data[].sections` | array of string | Разделы настроек формы, которые относятся к сценарию, например `fields`, `agreements`, `crm`, `design` |
| `data[].expertSections` | array of string | Расширенный набор разделов настроек формы |
| `data[].defaultSection` | string | Раздел настроек по умолчанию, одно из значений `sections` |
| `data[].openable` | boolean | Можно ли открыть сценарий в конструкторе форм |
| `data[].soon` | boolean | Сценарий помечен как готовящийся к выпуску |
| `data[].actions` | array of string | Действия сценария, например `check`, `showHelp`. Пустой массив, если действий нет |

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

Показаны два сценария из 26:

```json
{
  "success": true,
  "data": [
    {
      "id": "contacts",
      "title": "Контактные данные",
      "description": "Получите телефон, адрес почты, имя клиента",
      "categoryId": "crm",
      "iconUrl": "/bitrix/images/crm/webform/icons/contacts.svg",
      "sections": [
        "fields",
        "agreements",
        "header-and-button",
        "crm",
        "design",
        "other"
      ],
      "expertSections": [
        "fields",
        "booking-resource-auto-selection",
        "agreements",
        "crm",
        "pay-systems",
        "header-and-button",
        "spam-protection",
        "fields-rules",
        "actions",
        "default-values",
        "analytics",
        "callback",
        "design",
        "other"
      ],
      "defaultSection": "fields",
      "openable": true,
      "soon": false,
      "actions": []
    },
    {
      "id": "event_registration",
      "title": "Онлайн-события",
      "description": "Регистрация на онлайн-мероприятие",
      "categoryId": "events",
      "iconUrl": "/bitrix/images/crm/webform/icons/online.svg",
      "sections": [
        "fields",
        "agreements",
        "crm",
        "header-and-button",
        "actions",
        "default-values",
        "design",
        "other"
      ],
      "expertSections": [
        "fields",
        "booking-resource-auto-selection",
        "agreements",
        "crm",
        "pay-systems",
        "header-and-button",
        "spam-protection",
        "fields-rules",
        "actions",
        "default-values",
        "analytics",
        "callback",
        "design",
        "other"
      ],
      "defaultSection": "fields",
      "openable": true,
      "soon": false,
      "actions": [
        "check"
      ]
    }
  ]
}
```

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

400 — передан параметр строки запроса:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Unknown query parameter"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | Эндпоинт не принимает параметры строки запроса |
| 403 | `BITRIX_ACCESS_DENIED` | У пользователя Битрикс24 нет прав на формы |
| 403 | `BITRIX_INSUFFICIENT_SCOPE` | У токена Битрикс24 нет необходимого скоупа |
| 404 | `ENTITY_NOT_FOUND` | Портал не нашёл запрошенную сущность или описание поля. Исходный код — `error.b24Code` |
| 409 | `CRM_FORM_REST_NOT_ENABLED` | REST-методы CRM-форм недоступны на этом портале Битрикс24. Это не означает отсутствие отдельной формы |
| 400–599 | `CRM_FORM_*` | Отказ по правилам форм. Код и HTTP-статус сохранены, исходный код — в `error.b24Code` |
| 422 | `BITRIX_ERROR` | Другой отказ Битрикс24. Причина — в `error.message`, исходный код — в `error.b24Code` |
| 429 | `RATE_LIMITED` | Превышена частота запросов. Учитывайте заголовок `Retry-After` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 вернул ответ в неожиданном виде |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен: ошибка сервера или разрыв соединения |
| 503 | `BITRIX_TIMEOUT` | Битрикс24 не ответил вовремя. Чтение можно повторить |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `TOKEN_MISSING` | У ключа не настроен доступ к Битрикс24 |
| 403 | `SCOPE_DENIED` | У API-ключа Вайбкод нет скоупа `crm` |

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

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

- [Список категорий сценариев](/docs/entities/crm-forms/scenario-categories)
- [Получить конфигурацию конструктора](/docs/entities/crm-forms/configuration)
- [Создать форму](/docs/entities/crm-forms/create)
- [CRM-формы](/docs/entities/crm-forms)