Получить конфигурацию конструктора CRM-форм crm.form.configuration.get

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

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

Scope: crm

Кто может выполнять метод: пользователь с правом на просмотр CRM-форм

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

Метод crm.form.configuration.get возвращает справочники и настройки Битрикс24, которые нужны для сборки CRM-формы.

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

Без параметров.

Примеры кода

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

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

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

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 '{}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.form.configuration.get

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/crm.form.configuration.get

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type NamedId = { id: number, name: string }
type NamedCode = { id: string, name: string }

// Shape of the payload returned in result (match the "response handling" section of the page)
type FormConfigurationResult = {
  item: {
    entitySchemes: Array<{
      id: number
      name: string
      description: string
      entityNames: string[]
      mainEntityName: string | null
      hasInvoice: boolean
      dynamic: boolean
    }>
    duplicateModes: NamedCode[]
    lead: { enabled: boolean }
    dealCategories: NamedId[]
    smartProcesses: Array<{
      entityTypeId: number
      entityName: string
      name: string
      categories: NamedId[]
    }>
    languages: NamedCode[]
    currencies: Array<{ id: string, fullName: string, formatString: string }>
    fieldTypes: Array<{ id: string, name: string, parameters: string[] }>
    paySystems: NamedId[]
    permissions: { canRead: boolean, canEdit: boolean }
    limits: { activeForms: { current: number, maximum: number } | null }
    product: { isCloud: boolean, isRegionRussian: boolean }
    region: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<FormConfigurationResult>({
    method: 'crm.form.configuration.get',
    params: {},
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.item.entitySchemes)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getFormConfiguration() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'crm.form.configuration.get',
        params: {},
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.item.entitySchemes)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.crm.form.configuration.get().response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        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.form.configuration.get',
            []
        );

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

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

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

BX24.callMethod(
    'crm.form.configuration.get',
    {},
    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.form.configuration.get',
    []
);

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

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.form.configuration.get", b24.Params{}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("crm.form.configuration.get: %w", err)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	EntitySchemes []struct {
		ID          int      `json:"id"`
		Name        string   `json:"name"`
		EntityNames []string `json:"entityNames"`
	} `json:"entitySchemes"`
	Limits struct {
		ActiveForms *struct {
			Current int `json:"current"`
			Maximum int `json:"maximum"`
		} `json:"activeForms"`
	} `json:"limits"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(len(item.EntitySchemes))

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

HTTP-статус: 200

Пример сокращен: в массивах оставлено по несколько элементов.

{
    "result": {
        "item": {
            "entitySchemes": [
                {
                    "id": 1,
                    "name": "Лид",
                    "description": "лид",
                    "entityNames": ["LEAD", "COMPANY", "CONTACT"],
                    "mainEntityName": "LEAD",
                    "hasInvoice": false,
                    "dynamic": false
                },
                {
                    "id": 2,
                    "name": "Клиент",
                    "description": "контакт или компания",
                    "entityNames": ["CONTACT", "COMPANY"],
                    "mainEntityName": null,
                    "hasInvoice": false,
                    "dynamic": false
                },
                {
                    "id": 3,
                    "name": "Сделка",
                    "description": "сделка, контакт или компания",
                    "entityNames": ["DEAL", "COMPANY", "CONTACT"],
                    "mainEntityName": "DEAL",
                    "hasInvoice": false,
                    "dynamic": false
                },
                {
                    "id": 1770,
                    "name": "Закупка оборудования",
                    "description": "Смарт-процесс, контакт или компания",
                    "entityNames": ["DYNAMIC_177", "COMPANY", "CONTACT"],
                    "mainEntityName": "DYNAMIC_177",
                    "hasInvoice": false,
                    "dynamic": true
                }
            ],
            "duplicateModes": [
                {
                    "id": "MERGE",
                    "name": "Объединять"
                },
                {
                    "id": "REPLACE",
                    "name": "Заменять"
                }
            ],
            "lead": {
                "enabled": true
            },
            "dealCategories": [
                {
                    "id": 0,
                    "name": "Общая"
                },
                {
                    "id": 1,
                    "name": "Newest"
                }
            ],
            "smartProcesses": [
                {
                    "entityTypeId": 177,
                    "entityName": "DYNAMIC_177",
                    "name": "Закупка оборудования",
                    "categories": [
                        {
                            "id": 7,
                            "name": "Общее"
                        },
                        {
                            "id": 9,
                            "name": "Вторая воронка"
                        }
                    ]
                }
            ],
            "languages": [
                {
                    "id": "en",
                    "name": "English"
                },
                {
                    "id": "ru",
                    "name": "Русский"
                }
            ],
            "currencies": [
                {
                    "id": "RUB",
                    "fullName": "руб.",
                    "formatString": "# &#8381;"
                }
            ],
            "fieldTypes": [
                {
                    "id": "section",
                    "name": "Раздел",
                    "parameters": ["label"]
                },
                {
                    "id": "phone",
                    "name": "Телефон",
                    "parameters": ["label", "required", "multiple", "placeholder", "valueType", "value"]
                },
                {
                    "id": "hr",
                    "name": "Разрыв строки",
                    "parameters": []
                }
            ],
            "paySystems": [
                {
                    "id": 11,
                    "name": "Наличные"
                },
                {
                    "id": 31,
                    "name": "Оплата картой"
                }
            ],
            "permissions": {
                "canRead": true,
                "canEdit": true
            },
            "limits": {
                "activeForms": {
                    "current": 4,
                    "maximum": 99999
                }
            },
            "product": {
                "isCloud": true,
                "isRegionRussian": true
            },
            "region": "ru"
        }
    },
    "time": {
        "start": 1792593640,
        "finish": 1792593640.689641,
        "duration": 0.689640998840332,
        "processing": 0,
        "date_start": "2026-10-21T17:40:40+03:00",
        "date_finish": "2026-10-21T17:40:40+03:00",
        "operating_reset_at": 1792593600,
        "operating": 0
    }
}

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

Название `тип`	Описание
result `object`	Объект с данными ответа
item `object`	Объект с конфигурацией конструктора форм (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект item

Название `тип`	Описание
entitySchemes `object[]`	Схемы создания объектов CRM: какие объекты создает заполненная форма (подробное описание). Идентификатор схемы передается в поле `crm.entityScheme` при создании и изменении формы
duplicateModes `object[]`	Режимы обработки повторного заполнения формы: элементы с полями `id` и `name`. Значение `id` передается в поле `crm.duplicateMode`. На тестовом Битрикс24 возвращаются `MERGE` — объединять и `REPLACE` — заменять
lead `object`	Объект с полем `enabled` типа `boolean`: `true` — в CRM включены лиды `false` — CRM работает в простом режиме без лидов
dealCategories `object[]`	Воронки сделок: элементы с полями `id` и `name`. Значение `id` передается в поле `crm.dealCategoryId`. Общая воронка имеет идентификатор `0`
smartProcesses `object[]`	Смарт-процессы, элементы которых может создавать форма (подробное описание)
languages `object[]`	Языки формы: элементы с полями `id` и `name`. Значение `id` передается в поле `languageId`
currencies `object[]`	Валюты Битрикс24 (подробное описание)
fieldTypes `object[]`	Типы полей, из которых можно собрать форму (подробное описание). Значение `id` передается в поле `fields[].type`
paySystems `object[]`	Платежные системы, через которые можно оплатить заполненную форму: элементы с полями `id` и `name`. Идентификаторы систем, которые форма не должна предлагать, передаются в поле `payment.disabledPaySystemsId`. Если на Битрикс24 нет модуля `sale`, массив пустой
permissions `object`	Права текущего пользователя на CRM-формы: `canRead` — может просматривать формы `canEdit` — может создавать, изменять и удалять формы
limits `object`	Объект с полем `activeForms` — лимит активных форм: `current` — сколько форм сейчас активно `maximum` — сколько форм можно держать активными на тарифе Если количество активных форм на Битрикс24 не ограничено, `activeForms` равно `null`
product `object`	Сведения о продукте: `isCloud` — облачный Битрикс24 `isRegionRussian` — Битрикс24 российского региона
region `string`	Код региона Битрикс24, например `ru`

Элемент entitySchemes

Название `тип`	Описание
id `integer`	Идентификатор схемы
name `string`	Название схемы
description `string`	Описание схемы: какие объекты она создает
entityNames `string[]`	Коды объектов CRM, которые создает схема, например `LEAD`, `CONTACT`, `COMPANY`, `DYNAMIC_174`. Коды передаются в фильтр метода crm.form.entityfield.list, чтобы получить поля для формы
mainEntityName `string`	Код основного объекта схемы. Для схемы «Клиент» — `null`
hasInvoice `boolean`	Признак того, что схема создает счет
dynamic `boolean`	Признак схемы смарт-процесса

Элемент smartProcesses

Название `тип`	Описание
entityTypeId `integer`	Идентификатор типа смарт-процесса
entityName `string`	Код смарт-процесса, например `DYNAMIC_177`
name `string`	Название смарт-процесса
categories `object[]`	Воронки смарт-процесса: элементы с полями `id` и `name`. Значение `id` передается в поле `crm.smartProcessCategoryId`

Элемент currencies

Название `тип`	Описание
id `string`	Код валюты, например `RUB`
fullName `string`	Название валюты
formatString `string`	Шаблон вывода суммы, `#` заменяется суммой

Элемент fieldTypes

Название `тип`	Описание
id `string`	Код типа поля формы, например `string`, `phone`, `email`, `section`, `hr`
name `string`	Название типа поля
parameters `string[]`	Параметры, которые можно задать полю этого типа в элементе `fields[]`, например `label`, `required`, `multiple`, `placeholder`, `valueType`, `value`. Для разделителей `hr` и `br` массив пустой

В справочнике fieldTypes нет типов полей с вариантами выбора: список, флажки, переключатели. Через REST такие поля, а также товары и бронирование в форму пока добавить нельзя.

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

HTTP-статус: 403

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION",
        "message": "Доступ запрещен"
    }
}

Название `тип`	Описание
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_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	Выдайте пользователю право на просмотр CRM-форм

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

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	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

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

Обзор методов

Получить список полей конфигурации конструктора

Получить конфигурацию конструктора CRM-форм crm.form.configuration.get

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

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

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

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

Объект itemОбъект item

Элемент entitySchemesЭлемент entitySchemes

Элемент smartProcessesЭлемент smartProcesses

Элемент currenciesЭлемент currencies

Элемент fieldTypesЭлемент fieldTypes

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

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

Ошибка доступаОшибка доступа

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

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

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

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

Примеры кода

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

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

Объект item

Элемент entitySchemes

Элемент smartProcesses

Элемент currencies

Элемент fieldTypes

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

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

Ошибка доступа

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

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