## Список настроек CRM

`GET /v1/crm-settings`

Перечисляет настройки CRM, доступные пользователю ключа, вместе с текущими значениями и схемами допустимых значений.

> **Доступность:** в облаке метод доступен. Для коробочной установки требуется обновление CRM `crm 26.2000.0`. Без него API вернёт `422 METHOD_NOT_YET_AVAILABLE` с требуемым выпуском в `error.release`.

## Примеры

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

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

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

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

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

```javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/crm-settings', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_API_KEY"},
})
const result = await response.json()
```

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

```javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/crm-settings', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
})
const result = await response.json()
```

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

| Поле | Тип | Описание |
|---|---|---|
| `success` | boolean | `true` при успехе. |
| `data` | array | Массив доступных настроек. |
| `data[].id` | string | Идентификатор. |
| `data[].value` | any | Значение JSON без преобразования типов. Тип зависит от настройки, допустимые значения задаёт `meta.schema`. |
| `data[].meta.title` | string | Название настройки. |
| `data[].meta.description` | string | Описание настройки. |
| `data[].meta.schema` | object | Схема допустимого значения. Проверяется Битрикс24. |

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

Пример структуры с нейтральными данными.

```json
{
  "success": true,
  "data": [
    {
      "id": "crm.layout.file_previewer.enabled",
      "value": true,
      "meta": {
        "title": "File preview",
        "description": "Preview files",
        "schema": {
          "type": "boolean"
        }
      }
    }
  ]
}
```

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

400 — неизвестный параметр:

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

## Ошибки

| HTTP | Код | Описание |
|---|---|---|
| 400 | `UNKNOWN_FILTER_FIELD` | Неизвестный параметр запроса. |
| 401 | `TOKEN_MISSING` | Нет доступа к Битрикс24 у ключа. |
| 403 | `SCOPE_DENIED` | Нужен скоуп `crm`. |
| 422 | `METHOD_NOT_YET_AVAILABLE` | На портале нет метода. Требуемый выпуск указан в `error.release`. |
| 502 | `BITRIX_UNAVAILABLE` | Ответ Битрикс24 недоступен или имеет некорректную структуру. |

Другие отказы Битрикс24 сохраняют исходные код и текст. Общие [ошибки API](/docs/errors).

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

Объект в `value` передаётся целиком, без частичного объединения. Успешное изменение не отменяется, если чтение после записи завершилось ошибкой. Не повторяйте запись вслепую после неоднозначного сбоя: сначала прочитайте настройку.

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

- [Настройки CRM](/docs/entities/crm-settings)
- [Письма CRM](/docs/entities/crm-emails)
