Requisite fields

GET /v1/requisites/fields

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

Parameters

Examples

curl — personal key

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

curl — OAuth application

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 application

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 fields

Each field in the data.fields dictionary is described by an object:

• Vibecode schema fields in camelCase: { type, readonly, label, description }, where label and description are returned in English. Request headers do not switch the language. In the list, get, create, update and search responses the fields are returned under the camelCase name. Filtering and sorting use the same name, including id; the ID variant is accepted too.
• Custom UF_CRM_* fields in the original case: { type, readonly, label }, where label is the field name in the language of the Bitrix24 account.

Vibecode schema fields

Fields of requisite presets across countries. An international Bitrix24 account has two built-in presets, Company and Person; fields that belong to another country's preset — rqInn, rqKpp, rqOgrn and the like — stay in the schema and come back as null.

Service

Legal entities

Individuals

International presets

Fields of country-specific presets. They are populated only on requisites that use the corresponding country preset — on all other requisites they are returned as null.

Custom fields

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

Available includes

The GET /v1/requisites/fields endpoint returns the list of available includes: preset.

Usage example: Get requisite.

More on includes: Related data.

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" }
    },
    "relations": {
      "preset": { "type": "one", "entity": "requisite-presets", "includable": true }
    },
    "aggregatable": ["rqInn", "rqKpp", "rqOgrn", "rqOgrnip", "rqOkpo", "rqVatId", "rqResidenceCountry", "rqCompanyName", "presetId", "entityTypeId", "active"],
    "batch": ["create", "update", "delete"],
    "include": ["preset"]
  }
}

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

For the full list of common API errors, see Errors.

Known specifics

All active presets in one response. Without the presetId parameter, 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 and datetime fields Vibecode converts "" to null in the list, get, create, update and search responses. This does not affect the fields method — it returns only field metadata.

The label on custom fields. For UF_CRM_* fields a label is returned with the field name in the language of the Bitrix24 account. For Vibecode schema fields label and description are returned in English.

See also

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