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

Fields available to add

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

Returns the names of fields that can still be added to a requisite preset — those not yet part of it. Use it before POST /v1/requisite-presets/:presetId/fields to learn the allowed fieldName values.

Parameters

Parameter Type Required Description
presetId (path) number yes Requisite 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/available" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth app

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

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

JavaScript — OAuth app

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/requisite-presets/1/fields/available', {
  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 array Array of field names available to add
data[] string Field name in Bitrix24 format: standard fields — RQ_*, custom fields — UF_CRM_*

Response example

JSON 
{
  "success": true,
  "data": [
    "RQ_NAME",
    "RQ_FIRST_NAME",
    "RQ_LAST_NAME",
    "RQ_SECOND_NAME",
    "RQ_CONTACT",
    "RQ_EMAIL",
    "RQ_PHONE",
    "RQ_FAX",
    "RQ_IDENT_DOC",
    "RQ_IDENT_DOC_SER",
    "RQ_IDENT_DOC_NUM",
    "RQ_IDENT_DOC_DATE",
    "RQ_IDENT_DOC_ISSUED_BY",
    "RQ_IDENT_DOC_DEP_CODE",
    "RQ_IFNS",
    "RQ_OGRNIP",
    "RQ_OKVED"
  ]
}

Error response example

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

Errors

HTTP Code Description
400 INVALID_PRESET_ID The provided presetId 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 list shrinks as the preset fills up. Each added field disappears from the response. When all available fields have been added, data returns an empty array.

See also