#Requisite fields

GET /v1/requisites/fields

Returns the full list of requisite fields. Vibecode schema fields are returned in camelCase, custom UF_CRM_* fields — in the original Bitrix24 case. Each requisite stores values only for the fields that exist in its preset.

#Examples

#curl — personal key

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

#curl — OAuth app

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

#JavaScript — personal key

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

const { success, data } = await res.json()
console.log('Total fields:', Object.keys(data.fields).length)

#JavaScript — OAuth app

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

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

#Response format

The response is an object { success, data: { fields: {...} } }. Each field is described by an object:

• Vibecode schema fields in camelCase: { type, readonly }. In list, get, create, update, search responses they are returned under the camelCase name. Filtering and sorting use the same name.
• Custom UF_CRM_* fields in the original case: { type, readonly, label }, where label is the field name in the Bitrix24 account language.

#Vibecode schema fields

Fields of the Russian and international requisite presets.

#Service

#Legal entities

#Individuals

#International presets

Fields of other countries' presets. Filled only on requisites of the corresponding country preset — on Russian requisites they are returned as null.

#Custom fields

UF_CRM_* — fields configured in your Bitrix24 account via the Bitrix24 interface. Returned in the original case with an additional label.

#Response example

{
  "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": "Internal code" }
    }
  }
}

A small subset of fields is shown. The full set depends on the presets and custom fields configured in the Bitrix24 account.

#Error response example

401 — no tokens:

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

#Errors

Full list of common API errors — Errors.

#Known specifics

All active presets in one response. The method returns fields from all active presets of the Bitrix24 account, including country presets. On an individual requisite only the fields of its preset are filled; the rest are returned as null.

Empty values are normalized. For string/number/date/datetime fields Vibecode converts "" to null in list/get/create/update/search responses. This does not affect the fields method — it returns only field metadata.

Label (label) for custom fields. For UF_CRM_* fields a label is returned with the field name in the Bitrix24 account language. Vibecode schema fields have no label — their purpose is described in the tables above.

#See also

• Create requisite
• List requisites
• Entity API
• Limits and optimization