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

Get requisite preset

GET /v1/requisite-presets/:id

Returns a requisite preset by ID with all system fields.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionPreset ID

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/requisite-presets/1" \
  -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', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Preset:', data.name, '— country', data.countryId)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets/1', {
  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 DescriptionThe preset object
Fielddata.id Typenumber DescriptionPreset identifier
Fielddata.entityTypeId Typenumber DescriptionEntity type — always 8, requisite
Fielddata.countryId Typenumber DescriptionField-set country identifier, for example 122. The value depends on the country of the Bitrix24 account
Fielddata.name Typestring DescriptionPreset name
Fielddata.active Typeboolean DescriptionWhether the preset is active
Fielddata.sort Typenumber DescriptionSort order
Fielddata.xmlId Typestring | null DescriptionExternal identifier for synchronization
Fielddata.createdAt Typedatetime DescriptionCreation date (ISO 8601)
Fielddata.updatedAt Typedatetime | null DescriptionLast modification date; null if the preset was never modified
Fielddata.createdBy Typenumber DescriptionCreator identifier; 0 — created by the system
Fielddata.modifyBy Typenumber | null DescriptionLast editor identifier; null if the preset was never modified

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "entityTypeId": 8,
    "countryId": 122,
    "name": "Company",
    "active": true,
    "sort": 510,
    "xmlId": "#CRM_REQUISITE_PRESET_DEF_RU_COMPANY#",
    "createdAt": "2020-04-20T10:47:23.000Z",
    "updatedAt": "2021-08-13T14:34:26.000Z",
    "createdBy": 0,
    "modifyBy": 1
  }
}

Error response example

404 — preset not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The Preset with ID '999999' is not found"
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo preset with this ID found
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.

See also