#Поля реквизита

GET /v1/requisites/fields

Возвращает полный перечень полей реквизита. Поля схемы Вайбкод возвращаются в camelCase, пользовательские поля UF_CRM_* — в исходном регистре Битрикс24. Каждый реквизит хранит значения только тех полей, которые есть в его шаблоне.

#Примеры

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

curl "https://vibecode.bitrix24.tech/v1/requisites/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

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

curl "https://vibecode.bitrix24.tech/v1/requisites/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

const res = await fetch('https://vibecode.bitrix24.tech/v1/requisites/fields', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { success, data } = await res.json()
console.log('Всего полей:', Object.keys(data.fields).length)

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

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

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

#Формат ответа

Ответ — объект { success, data: { fields: {...} } }. Каждое поле описано объектом:

• Поля схемы Вайбкод в camelCase: { type, readonly }. В ответах list, get, create, update, search возвращаются под camelCase-именем. Фильтр и сортировка — по тому же имени.
• Пользовательские поля UF_CRM_* в исходном регистре: { type, readonly, label }, где label — название поля на языке портала.

#Поля схемы Вайбкод

Поля российских и международных шаблонов реквизита.

#Служебные

#Юрлица

#Физлица

#Международные шаблоны

Поля шаблонов других стран. Заполнены только на реквизитах соответствующего странового шаблона — на российских реквизитах возвращаются как null.

#Пользовательские поля

UF_CRM_* — поля, настроенные на портале через интерфейс Битрикс24. Возвращаются в исходном регистре с дополнительной меткой label.

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

{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityTypeId": { "type": "number", "readonly": false },
      "presetId": { "type": "number", "readonly": false },
      "rqInn": { "type": "string", "readonly": false },
      "rqKpp": { "type": "string", "readonly": false },
      "rqCompanyName": { "type": "string", "readonly": false },
      "rqDirector": { "type": "string", "readonly": false },
      "rqEdrpou": { "type": "string", "readonly": false },
      "rqRegon": { "type": "string", "readonly": false },
      "createdAt": { "type": "datetime", "readonly": true },
      "createdBy": { "type": "number", "readonly": true },

      "UF_CRM_1698325419": { "type": "string", "readonly": false, "label": "Внутренний код" }
    }
  }
}

Показана небольшая часть полей. Полный состав зависит от настроенных на портале шаблонов и пользовательских полей.

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

401 — нет токенов:

{
  "success": false,
  "error": {
    "code": "TOKEN_MISSING",
    "message": "API key has no OAuth tokens configured"
  }
}

#Ошибки

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

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

Все активные шаблоны в одном ответе. Метод возвращает поля со всех активных шаблонов портала, включая страновые. На отдельном реквизите заполнены только поля его шаблона, остальные возвращаются как null.

Пустые значения нормализованы. Для строковых, числовых, date и datetime полей Вайбкод приводит "" к null в ответах list, get, create, update, search. На метод fields это не влияет — он возвращает только метаданные поля.

Метка label у пользовательских полей. У полей UF_CRM_* возвращается label с названием поля на языке портала. У полей схемы Вайбкод label нет — их назначение описано в таблицах выше.

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

• Создать реквизит
• Список реквизитов
• Entity API
• Лимиты и оптимизация