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
id (path) number yes Preset ID

Examples

curl — personal key

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

curl — OAuth app

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 app

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
success boolean Always true on success
data object The preset object
data.id number Preset identifier
data.entityTypeId number Entity type — always 8, requisite
data.countryId number Field-set country identifier; 1 — Russia
data.name string Preset name
data.active boolean Whether the preset is active
data.sort number Sort order
data.xmlId string | null External identifier for synchronization
data.createdAt datetime Creation date (ISO 8601)
data.updatedAt datetime | null Last modification date; null if the preset was never modified
data.createdBy number Creator identifier; 0 — created by the system
data.modifyBy number | null Last editor identifier; null if the preset was never modified

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "entityTypeId": 8,
    "countryId": 1,
    "name": "Organization",
    "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
404 ENTITY_NOT_FOUND No preset with this ID found
403 SCOPE_DENIED API key lacks the crm scope
401 TOKEN_MISSING API key has no configured tokens

Full list of common API errors — Errors.

See also