## Получить открытые линии для формы

`GET /v1/crm-forms/:id/openlines`

Показывает открытые линии портала и их связь с выбранной CRM-формой.

## Параметры

| Параметр | Тип | Обяз. | По умолч. | Описание |
|-----------|-----|--------|-----------|-------------|
| `id` (path) | number | да | — | Положительный целый ID формы. Источник: [Список CRM-форм](/docs/entities/crm-forms/list) |
| `limit` (query) | number | нет | Умолчание Битрикс24 | Размер страницы. Значение проверяет Битрикс24 |
| `offset` (query) | number | нет | Умолчание Битрикс24 | Смещение. Значение проверяет Битрикс24 |
| `order` / `sort` (query) | object / string | нет | Умолчание Битрикс24 | Сортировка по ID: `order[id]=desc` или `sort=-id` |

Пагинация: один запрос получает одну страницу. Без `limit` и `offset` действует умолчание Битрикс24. Каждый параметр можно передать отдельно. Автоматического обхода страниц нет. `select` не поддерживается.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/crm-forms/91/openlines?sort=-id" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/crm-forms/91/openlines?sort=-id" \
  -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/91/openlines?sort=-id', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/91/openlines?sort=-id', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

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

| Поле | Тип | Описание |
|------|-----|-------------|
| `success` | boolean | Всегда `true` при успехе |
| `data` | array | Массив открытых линий |
| `data[].formId` | number | ID запрошенной формы. Источник: [Список CRM-форм](/docs/entities/crm-forms/list) |
| `data[].id` | number | ID открытой линии из этого списка |
| `data[].name` | string | Название из Битрикс24. Заменяются только учётные данные текущего соединения с путями в `meta.redacted` |
| `data[].bound` | boolean | Связан ли объект с запрошенной формой |
| `data[].welcomeFormEnabled` | boolean | Включена ли приветственная форма |
| `data[].welcomeFormId` | number \| null | ID приветственной формы. `null`, если приветственной формы нет. Источник: [Список CRM-форм](/docs/entities/crm-forms/list) |
| `data[].welcomeFormDelayed` | boolean | Отложен ли показ приветственной формы |
| `data[].previewUrl` | string \| null | Публичная ссылка предпросмотра, без изменений. `null`, если предпросмотр недоступен |
| `meta.limit` | number | Размер страницы, если передан в ответе Битрикс24 |
| `meta.offset` | number | Смещение, если передано в ответе Битрикс24 |
| `meta.total` | number | Общее количество записей. Поле отсутствует, если источник не передал количество |
| `meta.redacted` | string[] | Пути с заменёнными учётными данными текущего соединения |

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

Показаны первые два элемента. Публичные домены и подписи условные.

```json
{
  "success": true,
  "data": [
    {
      "formId": 91,
      "id": 59,
      "name": "doccheck: тест событий",
      "bound": false,
      "welcomeFormEnabled": true,
      "welcomeFormId": 25,
      "welcomeFormDelayed": true,
      "previewUrl": null
    },
    {
      "formId": 91,
      "id": 45,
      "name": "Открытая линия 24",
      "bound": false,
      "welcomeFormEnabled": true,
      "welcomeFormId": 25,
      "welcomeFormDelayed": true,
      "previewUrl": null
    }
  ]
}
```

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

400 — ID формы не является положительным целым числом:

```json
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive safe integer"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|-------------|
| 400 | `INVALID_PARAMS` | `id` не является положительным целым числом |
| 400 | `INVALID_PARAMS` | Неизвестный параметр строки запроса или некорректная структура `order` либо `sort` |
| 400 | `INVALID_PARAMS` | Переданы одновременно `order[...]` и `sort` |
| 400 | `INVALID_PARAMS` | Битрикс24 отклонил сортировку или пагинацию, например нечисловой `limit` или `offset`. Исходный код — в `error.b24Code`, ошибки полей — в `error.validation` |
| 401 | `TOKEN_MISSING` | Не настроен доступ к Битрикс24 или не передана OAuth-сессия |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `crm` |
| 403 | `BITRIX_ACCESS_DENIED` | Пользователю Битрикс24 запрещено чтение |
| 409 | `CRM_FORM_REST_NOT_ENABLED` | REST-методы CRM-форм выключены на портале. Исходный код отсутствующего метода — в `error.b24Code` |
| 403 | `BITRIX_INSUFFICIENT_SCOPE` | Токену Битрикс24 не хватает скоупа. Исходный код — в `error.b24Code` |
| 404 | `ENTITY_NOT_FOUND` | Форма не найдена |
| 422 | `BITRIX_ERROR` | Отказ Битрикс24 при обработке запроса |
| 429 | `RATE_LIMITED` | Превышен лимит запросов. Повторите после срока из `Retry-After` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен или прислал некорректный ответ |
| 503 | `BITRIX_TIMEOUT` | Битрикс24 не ответил за отведённое время. Повторите чтение после срока из `Retry-After` |

Ошибки Битрикс24 содержат исходный `error.b24Code` и переданные уточнения по полям в `error.validation`. Общие ошибки API — [Ошибки](/docs/errors).

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

Список включает все открытые линии портала, в том числе с `bound: false`. Чтобы выбрать связанные с формой объекты, отберите элементы с `bound: true` в полученном массиве. Параметр `bound` в запросе не поддерживается.

Требуется скоуп `crm`. Чтение доступно ключам с режимом `READONLY` и не меняет настройки объектов.

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

- [Список CRM-форм](/docs/entities/crm-forms/list)
- [Встраивание формы](/docs/entities/crm-forms/embedding)
- [CRM-формы](/docs/entities/crm-forms)
