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

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

GET /v1/crm-forms/configuration

Возвращает справочные данные конструктора CRM-форм на портале. Вызывайте перед созданием или изменением формы, чтобы выбрать схему сущностей, язык, воронку и проверить лимит активных форм.

Примеры

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/crm-forms/configuration" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/crm-forms/configuration" \
  -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-forms/configuration', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Активных форм:', data.limits.activeForms.current, 'из', data.limits.activeForms.maximum)

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-forms/configuration', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеКонфигурация конструктора с сохранением возвращённых свойств
Полеdata.entitySchemes Типarray ОписаниеСхемы сущностей CRM, которые создаёт форма
Полеdata.entitySchemes[].id Типnumber ОписаниеИдентификатор схемы. Значение для crm.entityScheme при создании формы
Полеdata.entitySchemes[].name Типstring ОписаниеНазвание схемы
Полеdata.entitySchemes[].description Типstring ОписаниеКакие сущности создаются по схеме
Полеdata.entitySchemes[].entityNames Типarray ОписаниеИмена сущностей схемы, например LEAD, COMPANY, CONTACT
Полеdata.entitySchemes[].mainEntityName Типstring | null ОписаниеОсновная сущность схемы. null у схемы без основной сущности, например «Клиент»
Полеdata.entitySchemes[].hasInvoice Типboolean ОписаниеСоздаёт ли схема счёт
Полеdata.entitySchemes[].dynamic Типboolean Описаниеtrue у схем смарт-процессов
Полеdata.duplicateModes Типarray ОписаниеРежимы обработки дублей
Полеdata.duplicateModes[].id Типstring ОписаниеКод режима: MERGE или REPLACE. Значение для crm.duplicateMode
Полеdata.duplicateModes[].name Типstring ОписаниеНазвание режима
Полеdata.lead.enabled Типboolean ОписаниеВключены ли лиды на портале
Полеdata.dealCategories Типarray ОписаниеВоронки сделок
Полеdata.dealCategories[].id Типnumber ОписаниеИдентификатор воронки. Значение для crm.dealCategoryId
Полеdata.dealCategories[].name Типstring ОписаниеНазвание воронки
Полеdata.smartProcesses Типarray ОписаниеСмарт-процессы портала
Полеdata.smartProcesses[].entityTypeId Типnumber ОписаниеИдентификатор типа смарт-процесса
Полеdata.smartProcesses[].entityName Типstring ОписаниеИмя сущности смарт-процесса в виде DYNAMIC_<entityTypeId>
Полеdata.smartProcesses[].name Типstring ОписаниеНазвание смарт-процесса
Полеdata.smartProcesses[].categories Типarray ОписаниеВоронки смарт-процесса
Полеdata.smartProcesses[].categories[].id Типnumber ОписаниеИдентификатор воронки. Значение для crm.smartProcessCategoryId
Полеdata.smartProcesses[].categories[].name Типstring ОписаниеНазвание воронки
Полеdata.languages Типarray ОписаниеЯзыки формы
Полеdata.languages[].id Типstring ОписаниеКод языка. Значение для languageId формы
Полеdata.languages[].name Типstring ОписаниеНазвание языка
Полеdata.currencies Типarray ОписаниеВалюты портала
Полеdata.currencies[].id Типstring ОписаниеКод валюты, например RUB
Полеdata.currencies[].fullName Типstring ОписаниеКраткое обозначение валюты
Полеdata.currencies[].formatString Типstring ОписаниеШаблон вывода суммы. # заменяется суммой
Полеdata.fieldTypes Типarray ОписаниеТипы полей формы
Полеdata.fieldTypes[].id Типstring ОписаниеКод типа. Значение для fields[].type формы
Полеdata.fieldTypes[].name Типstring ОписаниеНазвание типа
Полеdata.fieldTypes[].parameters Типarray ОписаниеНастройки, которые принимает поле этого типа: label, required, multiple, placeholder, valueType, value
Полеdata.paySystems Типarray ОписаниеПлатёжные системы портала
Полеdata.paySystems[].id Типnumber ОписаниеИдентификатор платёжной системы
Полеdata.paySystems[].name Типstring ОписаниеНазвание платёжной системы
Полеdata.permissions.canRead Типboolean ОписаниеМожет ли пользователь ключа читать формы
Полеdata.permissions.canEdit Типboolean ОписаниеМожет ли пользователь ключа изменять формы
Полеdata.limits.activeForms.current Типnumber ОписаниеСколько форм включено сейчас
Полеdata.limits.activeForms.maximum Типnumber ОписаниеСколько форм можно включить на портале
Полеdata.product.isCloud Типboolean Описаниеtrue для облачного Битрикс24
Полеdata.product.isRegionRussian Типboolean Описаниеtrue для портала российского региона
Полеdata.region Типstring ОписаниеКод региона портала, например ru

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

Показаны первые элементы массивов. Состав массивов зависит от портала.

JSON
{
  "success": true,
  "data": {
    "entitySchemes": [
      {
        "id": 1,
        "name": "Лид",
        "description": "лид",
        "entityNames": ["LEAD", "COMPANY", "CONTACT"],
        "mainEntityName": "LEAD",
        "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": "string", "name": "Строка", "parameters": ["label", "required", "multiple", "placeholder", "valueType", "value"] }
    ],
    "paySystems": [
      { "id": 1, "name": "Банковский перевод (Компании)" },
      { "id": 11, "name": "Наличные" }
    ],
    "permissions": { "canRead": true, "canEdit": true },
    "limits": { "activeForms": { "current": 4, "maximum": 99999 } },
    "product": { "isCloud": true, "isRegionRussian": true },
    "region": "ru"
  }
}

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

400 — передан параметр запроса:

JSON
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Unknown query parameter"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеЭндпоинт не принимает параметры строки запроса
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя Битрикс24 нет прав на формы
HTTP403 КодBITRIX_INSUFFICIENT_SCOPE ОписаниеУ токена Битрикс24 нет необходимого скоупа
HTTP404 КодENTITY_NOT_FOUND ОписаниеПортал не нашёл запрошенную сущность или описание поля. Исходный код — error.b24Code
HTTP409 КодCRM_FORM_REST_NOT_ENABLED ОписаниеREST-методы CRM-форм недоступны на этом портале Битрикс24. Это не означает отсутствие отдельной формы
HTTP400–599 КодCRM_FORM_* ОписаниеОтказ по правилам форм. Код и HTTP-статус сохранены, исходный код — в error.b24Code
HTTP422 КодBITRIX_ERROR ОписаниеДругой отказ Битрикс24. Причина — в error.message, исходный код — в error.b24Code
HTTP429 КодRATE_LIMITED ОписаниеПревышена частота запросов. Учитывайте заголовок Retry-After
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 вернул ответ в неожиданном виде
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 недоступен: ошибка сервера или разрыв соединения
HTTP503 КодBITRIX_TIMEOUT ОписаниеБитрикс24 не ответил вовремя. Чтение можно повторить
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа не настроен доступ к Битрикс24
HTTP403 КодSCOPE_DENIED ОписаниеУ API-ключа Вайбкод нет скоупа crm

Полный список общих ошибок API — Ошибки.

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

  • Идентификатор схемы смарт-процесса не равен entityTypeId. Для смарт-процесса 177 в entitySchemes приходит схема с id: 1770. В crm.entityScheme передавайте id схемы, а не entityTypeId.

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