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

GET /v1/requisites/fields

Возвращает полный перечень полей реквизита — 60 полей в Вайбкод-схеме (camelCase) + исходные поля Битрикс24 (UPPER_SNAKE_CASE) для международных пресетов, редких служебных полей и пользовательских UF_CRM_*. Каждый конкретный реквизит хранит значения только тех полей, которые есть в его пресете.

#Примеры

#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.
• Поля Битрикс24 вне схемы (UPPER_SNAKE_CASE): { type, readonly, label } — label на языке портала.

#Поля из схемы Вайбкод (60 полей)

Все возвращаются в camelCase, фильтруются и сортируются по camelCase-имени.

#Служебные

#Юрлица (российский пресет)

#Физлица

#Поля Битрикс24 вне схемы (в `UPPER_SNAKE_CASE`)

Эти поля возвращаются в ответах в исходном регистре Битрикс24. Фильтрация работает только по UPPER_SNAKE_CASE-имени.

#Международные пресеты

Намеренно не включены в Вайбкод-схему — будут мусором на российских порталах. Используются по мере настройки пресетов соответствующих стран.

#Редкие служебные поля

RQ_USRLE, RQ_IFNS, RQ_COMPANY_ID, RQ_IDENT_TYPE, RQ_IDENT_DOC_PERS_NUM, RQ_ST_CERT_SER/NUM/DATE, RQ_VAT_CERT_SER — используются редкими пресетами, оставлены в исходном регистре.

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

UF_CRM_* — кастомные поля, настроенные на портале (через UI Битрикс24). Возвращаются в ответах в исходном виде.

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

{
  "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 },
      "createdAt": { "type": "datetime", "readonly": true },
      "createdBy": { "type": "number", "readonly": true },

      "RQ_EDRPOU": { "type": "string", "readonly": false, "label": "ЕДРПОУ" },
      "RQ_REGON": { "type": "string", "readonly": false, "label": "REGON" },
      "UF_CRM_1698325419": { "type": "string", "readonly": false, "label": "Внутренний код" }
    }
  }
}

Показана небольшая часть полей. Реальное количество зависит от портала: 60 полей из Вайбкод-схемы + 30+ международных/служебных + пользовательские.

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

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

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

#Ошибки

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

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

Все активные пресеты в одном ответе. Метод возвращает полный список полей со всех активных пресетов портала.

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

Метки (label) на языке портала. У UPPER_SNAKE_CASE-полей возвращается label с переводом имени на язык портала (для RU-портала — русский, для EN — английский).

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

• Создать реквизит — какие поля передавать
• Список реквизитов — получение записей
• Entity API — select для выборки нужных полей
• Лимиты и оптимизация — rate limits