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

Get a preset field

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

Returns a single field row by its identifier within a requisite preset.

Parameters

Parameter Type Required Description
presetId (path) number yes Requisite preset ID. Get the list of presets: GET /v1/requisite-presets
id (path) number yes ID of the field row within the preset. Get the list: GET /v1/requisite-presets/:presetId/fields

Examples

curl — personal key

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

curl — OAuth app

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

const { success, data } = await res.json()
console.log('Field:', data.fieldName, '— sort order:', data.sort)

JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets/1/fields/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 field row object
data.id number ID of the field row within the preset
data.fieldName string System name of the requisite field: RQ_INN, RQ_COMPANY_NAME, etc.
data.fieldTitle string Field title. If not overridden, a single read returns the default name, e.g. "INN" for RQ_INN
data.inShortList boolean Whether the field is shown in the short requisite list
data.sort number Sort order of the field within the preset

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "fieldName": "RQ_INN",
    "fieldTitle": "INN",
    "inShortList": true,
    "sort": 500
  }
}

Error response example

404 — field not found:

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

Errors

HTTP Code Description
404 ENTITY_NOT_FOUND No field row with this id found in the preset
400 INVALID_PRESET_ID The provided presetId is not a positive integer
400 INVALID_FIELD_ID The provided id is not a positive integer
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.

Known specifics

The inShortList flag is a boolean. The field is returned as true or false, not Y/N.

fieldTitle contains the default name. Even when the field title is not overridden, reading a single row returns its name — "INN" for RQ_INN, "Contact person" for RQ_CONTACT. In the field list, the same field comes back with fieldTitle: "".

The field id is not the same as fieldName. The id parameter in the path is the numeric identifier of the field row within the preset — the id field from the GET /v1/requisite-presets/:presetId/fields response, not the system field name fieldName. To look up a field by name, call GET /v1/requisite-presets/:presetId/fields?filter[fieldName]=RQ_INN.

See also