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

Получить поле контракта формы

GET /v1/crm-forms/fields/:name

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

Параметры

Параметр Тип Обяз. Описание
Параметрname (path) Типstring Обяз.да ОписаниеИмя свойства формы, например name, fields, appearance, analytics, integrations или spamProtection. Список: data[].name в Поля контракта формы
Параметрselect (query) Типstring Обяз.нет ОписаниеСвойства метаданных через запятую, например name,type,multiple

Примеры

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

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

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

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

const { success, data } = await res.json()
console.log('Тип свойства:', data.type)

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеОписание свойства формы. Поля объекта те же, что у элемента data[] в Поля контракта формы

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

JSON 
{
  "success": true,
  "data": {
    "name": "analytics",
    "type": "object",
    "elementType": null,
    "multiple": false,
    "title": "analytics",
    "description": null,
    "validationRules": [],
    "requiredGroups": null,
    "filterable": false,
    "sortable": false,
    "editable": false
  }
}

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

404 — свойства с таким именем нет:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Поле `unknownProperty` не найдено",
    "b24Code": "BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодENTITY_NOT_FOUND ОписаниеСвойства с таким name нет. Исходный код — в error.b24Code
HTTP400 КодINVALID_PARAMS ОписаниеПередан неизвестный параметр запроса
HTTP400 КодINVALID_PARAMS Описаниеselect не является строкой или массивом строк
HTTP400 КодINVALID_PARAMS ОписаниеБитрикс24 отклонил проекцию. Исходный код — в error.b24Code
HTTP403 КодBITRIX_ACCESS_DENIED ОписаниеУ пользователя Битрикс24 нет прав на формы
HTTP403 КодBITRIX_INSUFFICIENT_SCOPE ОписаниеУ токена Битрикс24 нет необходимого скоупа
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 — Ошибки.

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