## List CRM card layouts

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

Read available CRM card layouts in the selected category.

> **These methods are rolling out — introduced in `crm 26.1700.0`.** Cloud availability also depends on Bitrix24 enabling this capability. Until it is enabled for your Bitrix24 account, the API returns `422 METHOD_NOT_YET_AVAILABLE` with `error.release`.

Requires `crm` scope. READONLY keys may read.

## Parameters

| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| `entityType` (path) | string | yes | — | Type from the [section index](/docs/entities/crm-card-layouts). |
| `categoryId` (query) | integer | yes | — | Category from [`GET /v1/categories`](/docs/entities/categories), `0` is accepted. |
| `userId` (query) | integer | no | — | Employee from the [user list](/docs/entities/users). Omit to use the calling employee. |
| `limit` (query) | integer | no | Bitrix24 | Single-page parameter checked by Bitrix24. |
| `offset` (query) | integer | no | Bitrix24 | Single-page parameter checked by Bitrix24. |

## Examples

### curl — personal key

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

### curl — OAuth application

```bash
curl -X GET "https://vibecode.bitrix24.com/v1/crm/card-layouts/deal?categoryId=0" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

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

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/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());
```

## Response fields

| Field | Type | Description |
|---|---|---|
| `success` | boolean | `true` |
| `data` | array | Layouts. |
| `data[].id` | string | String layout ID. |
| `data[].name` | string/null | Name, may be `null` for a system layout. |
| `data[].configuration` | object[] | Sections `{name,title,elements}` with elements `{name,optionFlags?,options?}`. |
| `data[].audience` | object[]/null | Audience `{type,id}`, may be `null` for a system layout. |

## Response example

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

## Error response example

`400` — category omitted:

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

## Errors

| HTTP | Code | Description |
|---|---|---|
| 400 | `MISSING_REQUIRED_FIELDS` | Category or required body fields missing. |
| 400 | `INVALID_PARAMS` | Unsupported entity selector or malformed parameters. |
| 400 | `UNKNOWN_FILTER_FIELD` | Unknown query parameter. |
| 401 | `MISSING_API_KEY` | API key missing. |
| 401 | `TOKEN_MISSING` | Bitrix24 credentials missing. |
| 403 | `SCOPE_DENIED` | The key lacks `crm` scope. |
| 422 | `METHOD_NOT_YET_AVAILABLE` | Capability disabled or method unavailable. `error.release` names the release. |
| 422 | `BITRIX_ERROR` | Bitrix24 refusal. Original code in `error.b24Code`, text in `error.message`. |
| 502 | `BITRIX_UNAVAILABLE` | No valid response from Bitrix24. |

Common errors: [Errors](/docs/errors).

## Known specifics

Each call reads one page. There is no total, `hasMore` or automatic page traversal.

## See also

- [Named CRM card layouts](/docs/entities/crm-card-layouts)