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

Requisite preset fields

GET /v1/requisite-presets/fields

Returns the schema of requisite preset fields: types and the read-only flag.

Examples

curl — personal key

Terminal

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

curl — OAuth app

Terminal

curl "https://vibecode.bitrix24.com/v1/requisite-presets/fields" \
  -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/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

javascript

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

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

Response fields

The response is an object { success, data: { fields: {...} } }. Each field is described by an object { type, readonly, label, description }, where label is a human-readable field name and description explains it. Both are returned in English. Request headers do not switch the language.

Field	Bitrix24	Type	RO	Description
`id`	`ID`	number	yes	Preset identifier
`entityTypeId`	`ENTITY_TYPE_ID`	number		Entity type — always `8`, requisite. Set when the preset is created. Flagged `createOnly` in the schema; sending it in the update body is rejected with `400 READONLY_FIELD`
`countryId`	`COUNTRY_ID`	number		Country identifier for the field set. Set when the preset is created. Flagged `createOnly` in the schema; sending it in the update body is rejected with `400 READONLY_FIELD`
`name`	`NAME`	string		Preset name
`active`	`ACTIVE`	boolean		Whether the preset is active
`sort`	`SORT`	number		Sort order
`xmlId`	`XML_ID`	string		External identifier for synchronization
`createdAt`	`DATE_CREATE`	datetime	yes	Creation date
`updatedAt`	`DATE_MODIFY`	datetime	yes	Last modification date
`createdBy`	`CREATED_BY_ID`	number	yes	Creator identifier
`modifyBy`	`MODIFY_BY_ID`	number	yes	Last editor identifier

xmlId, updatedAt, modifyBy can be null. The createdBy field equals 0 for system-created presets.

Response example

JSON

{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityTypeId": { "type": "number", "readonly": false, "createOnly": true },
      "countryId": { "type": "number", "readonly": false, "createOnly": true },
      "name": { "type": "string", "readonly": false },
      "active": { "type": "boolean", "readonly": false },
      "sort": { "type": "number", "readonly": false },
      "xmlId": { "type": "string", "readonly": false },
      "createdAt": { "type": "datetime", "readonly": true },
      "updatedAt": { "type": "datetime", "readonly": true },
      "createdBy": { "type": "number", "readonly": true },
      "modifyBy": { "type": "number", "readonly": true }
    }
  }
}

Error response example

403 — missing scope: