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
ParameterpresetId (path) Typenumber Requiredyes DescriptionRequisite 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 application

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 application

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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeunknown DescriptionThe raw result of Bitrix24 crm.requisite.preset.field.availabletoadd, with its structure and keys unchanged. A missing or null result is returned as []

Response example

The example below shows a result containing an array of strings. This route does not guarantee that shape: the response structure depends on the Bitrix24 result.

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
HTTP400 CodeINVALID_PRESET_ID DescriptionThe provided presetId is not a positive integer
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.

Known specifics

The list shrinks as the preset fills up. Each added field disappears from the available list. An empty collection retains the shape returned by Bitrix24. A missing or null result is replaced with [].

See also