Получить список дополнительных видов карточки v 3.0 crm.<тип>.detailpagelayout.list

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: crm

Кто может выполнять метод: любой пользователь. С фильтром по userId другого пользователя — администратор CRM

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод crm.<тип>.detailpagelayout.list возвращает дополнительные виды карточки элемента CRM в воронке. Тип объекта задает сегмент <тип> в имени метода.

В список попадают только дополнительные виды, доступные пользователю, — те, в аудитории которых он есть. Пользователь с правом изменять общий вид карточки получает все дополнительные виды воронки. Личный и общий вид в список не входят, их идентификаторы возвращают методы crm.<тип>.detailpagelayout.getpersonallayoutid и crm.<тип>.detailpagelayout.getcommonlayoutid.

Имя метода для типа объекта

Тип объекта	Метод
Сделка	`crm.deal.detailpagelayout.list`
Лид	`crm.lead.detailpagelayout.list`
Контакт	`crm.contact.detailpagelayout.list`
Компания	`crm.company.detailpagelayout.list`
Предложение	`crm.quote.detailpagelayout.list`
Счет	`crm.smartinvoice.detailpagelayout.list`
Документ CRM	`crm.smartdocument.detailpagelayout.list`
Документ КЭДО	`crm.smartb2edocument.detailpagelayout.list`
Смарт-процесс	`crm.smartprocess<entityTypeId>.detailpagelayout.list`, например `crm.smartprocess1038.detailpagelayout.list`

Для смарт-процесса в имя метода подставляется идентификатор его типа entityTypeId. Идентификаторы типов можно получить методом crm.type.list. Методы видов карточки есть у смарт-процесса при любых настройках типа. У моей компании этих методов нет.

Имя метода пишется в нижнем регистре: crm.deal.detailpagelayout.list, а не crm.deal.detailPageLayout.list. На имя в другом регистре метод отвечает ошибкой «Метод не найден».

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

filter*
object

Фильтр в формате {"поле": значение} (подробное описание)

pagination
object

Параметры постраничной навигации:

page — номер страницы
limit — количество видов на странице, по умолчанию 50, максимум 1000
offset — смещение. Если передан page, смещение вычисляется по page и limit

Параметр filter

Обязательные параметры отмечены *

Название
тип

Описание

categoryId*
integer

Идентификатор воронки. Виды карточки хранятся отдельно для каждой воронки.

Значение зависит от типа объекта:

лид и предложение — только 0, воронок у них нет
сделка, контакт и компания — идентификатор воронки, 0 — воронка по умолчанию
счет, документы и смарт-процесс — идентификатор воронки. Значение 0 метод заменяет идентификатором воронки по умолчанию

Идентификаторы воронок сделок, контактов, компаний и смарт-процессов можно получить методом crm.<тип>.category.list

userId
integer

Идентификатор пользователя, для которого нужен список доступных видов. Передавать идентификатор другого пользователя может только администратор CRM.

По умолчанию — пользователь, который вызывает метод.

Идентификаторы пользователей можно получить методом user.get

Другие поля фильтр не принимает. Сортировки и выбора полей у метода нет: виды возвращаются целиком.

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/crm.smartprocess1038.detailpagelayout.list

Примеры получают первые 10 дополнительных видов карточки смарт-процесса с идентификатором типа 1038 в воронке по умолчанию. Для другого типа объекта замените имя метода по таблице выше.

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"categoryId":0},"pagination":{"limit":10,"page":1}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.detailpagelayout.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"categoryId":0},"pagination":{"limit":10,"page":1},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.detailpagelayout.list

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make: такой вызов вернет ошибку SDK JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type LayoutElement = {
  name: string
  optionFlags?: number
  options?: Record<string, unknown>
}

type LayoutSection = {
  name: string
  title: string
  elements: LayoutElement[]
}

type Layout = {
  id: string
  configuration: LayoutSection[]
  name: string | null
  audience: { type: string; id: number }[] | null
}

type LayoutListResult = {
  items: Layout[]
}

try {
  const response = await $b24.getHttpClient(ApiVersion.v3).call<LayoutListResult>(
    'crm.smartprocess1038.detailpagelayout.list',
    {
      filter: { categoryId: 0 },
      pagination: { limit: 10, page: 1 },
    },
    Text.getUuidRfc4122()
  )

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    for (const layout of result.items) {
      console.info(layout.id, layout.name)
    }
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

Методы CRM пока не входят в список методов REST 3.0, который знает $b24.actions.v3.call.make. Вызывайте метод через HTTP-клиент REST 3.0 — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function listLayouts() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
        'crm.smartprocess1038.detailpagelayout.list',
        {
          filter: { categoryId: 0 },
          pagination: { limit: 10, page: 1 },
        },
        B24Js.Text.getUuidRfc4122()
      )

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      for (const layout of result.items) {
        console.info(layout.id, layout.name)
      }
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listLayouts)
</script>

У методов CRM нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через bitrix_token.call_method с prefer_version=3.

from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError

method = "crm.smartprocess1038.detailpagelayout.list"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "filter": {"categoryId": 0},
            "pagination": {"limit": 10, "page": 1},
        },
        prefer_version=3,
    )
    result = response["result"]
    for layout in result["items"]:
        print(layout["id"], layout["name"])
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.smartprocess1038.detailpagelayout.list',
            [
                'filter' => ['categoryId' => 0],
                'pagination' => ['limit' => 10, 'page' => 1],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'crm.smartprocess1038.detailpagelayout.list',
    {
        filter: { categoryId: 0 },
        pagination: { limit: 10, page: 1 },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'crm.smartprocess1038.detailpagelayout.list',
    [
        'filter' => ['categoryId' => 0],
        'pagination' => ['limit' => 10, 'page' => 1],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.smartprocess1038.detailpagelayout.list", b24.Params{
	"filter":     b24.Params{"categoryId": 0},
	"pagination": b24.Params{"limit": 10, "page": 1},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.smartprocess1038.detailpagelayout.list: %w", err)
}

var layouts []struct {
	ID       string `json:"id"`
	Name     string `json:"name"`
	Audience []struct {
		Type string `json:"type"`
		ID   int    `json:"id"`
	} `json:"audience"`
}
raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
	return fmt.Errorf("в ответе нет items")
}
if err := json.Unmarshal(raw, &layouts); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, layout := range layouts {
	fmt.Println(layout.ID, layout.Name)
}

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": "17",
                "configuration": [
                    {
                        "name": "main",
                        "title": "О заявке",
                        "elements": [
                            {
                                "name": "TITLE"
                            },
                            {
                                "name": "STAGE_ID"
                            },
                            {
                                "name": "OPPORTUNITY_WITH_CURRENCY"
                            },
                            {
                                "name": "ASSIGNED_BY_ID"
                            }
                        ]
                    }
                ],
                "name": "Карточка для отдела закупок",
                "audience": [
                    {
                        "type": "department",
                        "id": 47
                    },
                    {
                        "type": "user",
                        "id": 1
                    }
                ]
            }
        ]
    },
    "time": {
        "start": 1793706641,
        "finish": 1793706641.396112,
        "duration": 0.39611196517944336,
        "processing": 0,
        "date_start": "2026-11-03T14:50:41+03:00",
        "date_finish": "2026-11-03T14:50:41+03:00",
        "operating_reset_at": 1793707200,
        "operating": 0
    }
}

Возвращаемые данные

Название `тип`	Описание
result `object`	Объект с данными ответа
result.items `object[]`	Дополнительные виды карточки (подробное описание). Если видов нет, массив пустой
time `time`	Информация о времени выполнения запроса

Общее количество видов метод не возвращает. Если на странице столько видов, сколько указано в limit, запросите следующую страницу.

Объект вида карточки

Название `тип`	Описание
id `string`	Идентификатор дополнительного вида — число в строке, например `"17"`
configuration `object[]`	Разделы карточки в порядке вывода (подробное описание)
name `string`	Название дополнительного вида
audience `object[]`	Участники, которым доступен дополнительный вид (подробное описание)

Раздел карточки

Название `тип`	Описание
name `string`	Код раздела, например `main`
title `string`	Заголовок раздела в карточке
elements `object[]`	Поля раздела в порядке вывода. У каждого поля есть `name` — имя поля в карточке, например `TITLE`. Ключи `optionFlags` и `options` есть, только если они сохранены в виде: `optionFlags` равен `1`, если поле показывается всегда, и `0`, если только заполненным. В `options` — настройки поля, например `{"defaultCountry": "RU"}`

Участник аудитории

Название `тип`	Описание
type `string`	Тип участника: `user` — сотрудник, `department` — отдел с подотделами, `project` — группа или проект, `structure-node` — узел структуры компании
id `integer`	Идентификатор участника

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации фильтров объекта запроса",
        "validation": [
            {
                "message": "Требуется указать фильтр по обязательному полю `categoryId`",
                "field": "filter.categoryId"
            }
        ]
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки видов карточки приходят с короткими кодами без префикса BITRIX_REST_V3_, например LAYOUT_NOT_FOUND, и с текстом на английском языке. HTTP-статус у таких ошибок разный, он указан рядом с кодом. Ошибки с кодами BITRIX_REST_V3_* приходят со статусом 400.

Ошибка обязательного фильтра

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`filter.categoryId`	Требуется указать фильтр по обязательному полю `categoryId`	Передайте `categoryId` в `filter`

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`filter`	Обязательное поле `filter` не указано	Передайте `filter` с `categoryId`
`filter.categoryId`	В поле `filter.categoryId` требуется тип данных `int` для такого запроса	Передайте `categoryId` числом

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Неизвестное поле `#FIELD#` для сущности `LayoutDto`	Уберите лишний параметр или поле фильтра. Запрос принимает `filter` и `pagination`, фильтр — `categoryId` и `userId`

Ошибка постраничной навигации

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Не удается распознать параметр пагинации `#VALUE#`	Передайте в `pagination` только `page`, `limit` и `offset` целыми числами. `limit` — больше нуля

Ошибка формата фильтра

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Не удается распознать выражение фильтра `#VALUE#`	Передайте в `filter` значения `categoryId` не меньше `0` и `userId` не меньше `1`

Неподдерживаемая воронка

Код ошибки: UNSUPPORTED_CONTEXT, HTTP-статус: 400

Поле	Описание ошибки	Как исправить
`-`	This form layout context is not supported.	Проверьте `categoryId`: у лида и предложения передавайте `0`, у остальных типов — идентификатор существующей воронки этого типа объекта

Нет доступа

Код ошибки: PERMISSION_DENIED, HTTP-статус: 403

Поле	Описание ошибки	Как исправить
`-`	Insufficient permissions to work with this form layout.	Список видов другого пользователя может получить только администратор CRM

Ошибка хранилища

Код ошибки: STORAGE_FAILED, HTTP-статус: 500

Поле	Описание ошибки	Как исправить
`-`	Could not complete the operation on the form layout.	Повторите запрос позже. Если ошибка повторяется, обратитесь в поддержку

Метод не найден

Код ошибки: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP-статус 404

Поле	Описание ошибки	Как исправить
`-`	Метод `#METHOD#` не найден	Проверьте имя метода: оно пишется в нижнем регистре, например `crm.deal.detailpagelayout.list`. У моей компании методов видов карточки нет. Для смарт-процесса проверьте `entityTypeId` методом crm.type.list

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Получить вид карточки

Удалить дополнительный вид карточки

Получить список дополнительных видов карточки v 3.0 crm.<тип>.detailpagelayout.list

Имя метода для типа объектаИмя метода для типа объекта

Параметры методаПараметры метода

Параметр filterПараметр filter

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект вида карточкиОбъект вида карточки

Раздел карточкиРаздел карточки

Участник аудиторииУчастник аудитории

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Ошибка обязательного фильтраОшибка обязательного фильтра

Ошибки валидации запросаОшибки валидации запроса

Ошибка неизвестного поляОшибка неизвестного поля

Ошибка постраничной навигацииОшибка постраничной навигации

Ошибка формата фильтраОшибка формата фильтра

Неподдерживаемая воронкаНеподдерживаемая воронка

Нет доступаНет доступа

Ошибка хранилищаОшибка хранилища

Метод не найденМетод не найден

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Была ли статья полезна?

Имя метода для типа объекта

Параметры метода

Параметр filter

Примеры кода

Обработка ответа

Возвращаемые данные

Объект вида карточки

Раздел карточки

Участник аудитории

Обработка ошибок

Возможные коды ошибок

Ошибка обязательного фильтра

Ошибки валидации запроса

Ошибка неизвестного поля

Ошибка постраничной навигации

Ошибка формата фильтра

Неподдерживаемая воронка

Нет доступа

Ошибка хранилища

Метод не найден

Статусы и коды системных ошибок

Продолжите изучение