Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-card-layouts/list.md индекс документации — /llms.txt

Список раскладок карточки 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 Обяз.да По умолч.— ОписаниеТип из индекса раздела.
ПараметрcategoryId (query) Типinteger Обяз.да По умолч.— ОписаниеКатегория из GET /v1/categories, 0 допустим.
ПараметрuserId (query) Типinteger Обяз.нет По умолч.— ОписаниеСотрудник из списка пользователей. Если не указан, используется вызывающий сотрудник.
Параметрlimit (query) Типinteger Обяз.нет По умолч.Битрикс24 ОписаниеПараметр одной страницы, проверяется Битрикс24.
Параметрoffset (query) Типinteger Обяз.нет По умолч.Битрикс24 ОписаниеПараметр одной страницы, проверяется Битрикс24.

Примеры

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

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

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

Terminal 
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 Код Описание
HTTP400 КодMISSING_REQUIRED_FIELDS ОписаниеНет категории или обязательных полей тела.
HTTP400 КодINVALID_PARAMS ОписаниеНеподдерживаемый тип сущности или некорректная форма параметров.
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный параметр запроса.
HTTP401 КодMISSING_API_KEY ОписаниеНе передан ключ.
HTTP401 КодTOKEN_MISSING ОписаниеНет учётных данных портала.
HTTP403 КодSCOPE_DENIED ОписаниеНет скоупа crm.
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеВозможность не включена или метода ещё нет. error.release указывает выпуск.
HTTP422 КодBITRIX_ERROR ОписаниеОтказ Битрикс24. Исходный код в error.b24Code, текст в error.message.
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеНет корректного ответа портала.

Общие ошибки — Ошибки.

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

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

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