For AI agents: markdown of this page — /docs-content-en/entities/requisite-presets/preset-fields/schema.md documentation index — /llms.txt

Preset field schema

GET /v1/requisite-presets/:presetId/fields/schema

Returns the structure of a requisite preset field row: types, required flags, access flags. Use it to learn the allowed types and rules before POST /v1/requisite-presets/:presetId/fields or PATCH /v1/requisite-presets/:presetId/fields/:id.

Parameters

Parameter Type Required Description
ParameterpresetId (path) Typenumber Requiredyes DescriptionRequisite preset ID. Get the list of presets: GET /v1/requisite-presets

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/requisite-presets/1/fields/schema" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/requisite-presets/1/fields/schema" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

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

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

JavaScript — OAuth application

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

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionObject describing the schema
Fielddata.fields Typeobject DescriptionDictionary of preset row fields. The keys are in camelCase: id, fieldName, and others
Fielddata.fields.id Typeobject DescriptionField row identifier. Read-only
Fielddata.fields.fieldName Typeobject DescriptionRequisite field name, for example RQ_INN. Required on create. On update it does not need to be passed — the current value is substituted automatically
Fielddata.fields.fieldTitle Typeobject DescriptionField title in the printed form. Not required
Fielddata.fields.sort Typeobject DescriptionSort order of the field within the preset
Fielddata.fields.inShortList Typeobject DescriptionWhether the field is shown in the short list. Represented in the API as true/false

Each field in data.fields is described by an object with the following keys:

Key Type Description
Keytype Typestring DescriptionValue type: integer, string, boolean
KeyisRequired Typeboolean DescriptionWhether the field is required on create
KeyisReadOnly Typeboolean DescriptionRead-only — cannot be set on write
KeyisImmutable Typeboolean DescriptionCannot be changed after creation
KeyisMultiple Typeboolean DescriptionAllows multiple values
KeyisDynamic Typeboolean DescriptionDynamic (custom) field
Keytitle Typestring DescriptionHuman-readable field name in the Bitrix24 account language

Response example

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ID"
      },
      "fieldName": {
        "type": "string",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Name"
      },
      "fieldTitle": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Title in the preset"
      },
      "sort": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Sort"
      },
      "inShortList": {
        "type": "boolean",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Show in short list"
      }
    }
  }
}

Error response example

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PRESET_ID DescriptionThe provided presetId is not a positive integer
HTTP403 CodeSCOPE_DENIED DescriptionAPI key lacks the crm scope
HTTP401 CodeTOKEN_MISSING DescriptionAPI key has no configured tokens

Full list of common API errors — Errors.

Known specifics

The inShortList field is boolean both in the schema and in the data. When writing via POST or PATCH, pass true/false. In read responses the field arrives as true/false. Bitrix24 declares this field as char in its own schema description — Vibecode normalizes it to boolean so the schema does not contradict the rows it describes.

The schema declares fieldName as required (isRequired: true), but it does not need to be passed on update. On a PATCH without fieldName, Vibecode fetches the current value from Bitrix24 and substitutes it automatically. fieldName remains required when creating via POST.

See also