## Список раскладок карточки CRM

`GET /v1/crm/card-layouts/:entityType`

Читает доступные раскладки карточки CRM в выбранной категории.

> **Методы в процессе раскатки — появились в обновлении `crm 26.1700.0`.** Облачная доступность зависит от включения возможности Битрикс24. Пока она не открыта для портала, API отвечает `422 METHOD_NOT_YET_AVAILABLE` с `error.release`.

Нужен скоуп `crm`. Чтение разрешено `READONLY`.

## Параметры

| Параметр | Тип | Обяз. | По умолч. | Описание |
|---|---|---|---|---|
| `entityType` (path) | string | да | — | Тип из [индекса раздела](/docs/entities/crm-card-layouts). |
| `categoryId` (query) | integer | да | — | Категория из [`GET /v1/categories`](/docs/entities/categories), `0` допустим. |
| `userId` (query) | integer | нет | — | Сотрудник из [списка пользователей](/docs/entities/users). Если не указан, используется вызывающий сотрудник. |
| `limit` (query) | integer | нет | Битрикс24 | Параметр одной страницы, проверяется Битрикс24. |
| `offset` (query) | integer | нет | Битрикс24 | Параметр одной страницы, проверяется Битрикс24. |

## Примеры

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

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/crm/card-layouts/deal?categoryId=0" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/crm/card-layouts/deal?categoryId=0" \
  -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/card-layouts/deal?categoryId=0', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_API_KEY"},
});
console.log(await res.json());
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm/card-layouts/deal?categoryId=0', {
  method: 'GET',
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN"},
});
console.log(await res.json());
```

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

| Поле | Тип | Описание |
|---|---|---|
| `success` | boolean | `true` |
| `data` | array | Раскладки. |
| `data[].id` | string | Строковый ID раскладки. |
| `data[].name` | string/null | Название, у системной раскладки может быть `null`. |
| `data[].configuration` | object[] | Разделы `{name,title,elements}` с элементами `{name,optionFlags?,options?}`. |
| `data[].audience` | object[]/null | Аудитория `{type,id}`, у системной раскладки может быть `null`. |

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

```json
{
  "success": true,
  "data": [
    {
      "id": "11",
      "name": "VIBE-PROBE",
      "configuration": [
        {
          "name": "main",
          "title": "VIBE-PROBE",
          "elements": [
            {
              "name": "TITLE"
            }
          ]
        }
      ],
      "audience": [
        {
          "type": "user",
          "id": 1
        }
      ]
    }
  ]
}
```

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

`400` — не передана категория:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "categoryId is required"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|---|---|---|
| 400 | `MISSING_REQUIRED_FIELDS` | Нет категории или обязательных полей тела. |
| 400 | `INVALID_PARAMS` | Неподдерживаемый тип сущности или некорректная форма параметров. |
| 400 | `UNKNOWN_FILTER_FIELD` | Неизвестный параметр запроса. |
| 401 | `MISSING_API_KEY` | Не передан ключ. |
| 401 | `TOKEN_MISSING` | Нет учётных данных портала. |
| 403 | `SCOPE_DENIED` | Нет скоупа `crm`. |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Возможность не включена или метода ещё нет. `error.release` указывает выпуск. |
| 422 | `BITRIX_ERROR` | Отказ Битрикс24. Исходный код в `error.b24Code`, текст в `error.message`. |
| 502 | `BITRIX_UNAVAILABLE` | Нет корректного ответа портала. |

Общие ошибки — [Ошибки](/docs/errors).

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

Один вызов читает одну страницу. Общего количества и признака `hasMore` нет, автоматического обхода страниц нет.

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

- [Именованные раскладки карточки CRM](/docs/entities/crm-card-layouts)