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

Get an enumeration field value

GET /v1/userfields/:entity/enum-values/:id

Retrieves one CRM enumeration field option by its ID so you can inspect its current label and properties.

This feature is rolling out. It requires a CRM update after 26.2200.0 and activation by an administrator. The release version has not been published. Until available, requests return 422 METHOD_NOT_YET_AVAILABLE with error.release.

For Smart Process Automation (SPA) fields, use the same contract at GET /v1/items/:entityTypeId/userfields/enum-values/:id. Invoices are also available through entityTypeId=31.

Parameters

Parameter Type Required Default Description
Parameterentity (path) Typestring Requiredyes Default— Descriptiondeals — deals, leads — leads, contacts — contacts, companies — companies, quotes — estimates, invoices — invoices
ParameterentityTypeId (path) Typeinteger Requiredfor the alternate path Default— DescriptionSPA type ID, or 31 for invoices
Parameterid (path) Typeinteger Requiredyes Default— DescriptionPositive option ID from the list or creation response

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/userfields/deals/enum-values/4119" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/userfields/deals/enum-values/4119" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch(
  'https://vibecode.bitrix24.com/v1/userfields/deals/enum-values/4119',
  {
    "method": "GET",
    "headers": {
      "X-Api-Key": "YOUR_API_KEY"
    }
  }
)
const { success, data } = await response.json()

JavaScript — OAuth application

javascript 
const response = await fetch(
  'https://vibecode.bitrix24.com/v1/userfields/deals/enum-values/4119',
  {
    "method": "GET",
    "headers": {
      "X-Api-Key": "YOUR_APP_KEY",
      "Authorization": "Bearer USER_SESSION_TOKEN"
    }
  }
)
const { success, data } = await response.json()

Response fields

HTTP 200 OK.

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata Typeobject DescriptionField option
Fielddata.id Typeinteger DescriptionOption ID for retrieval
Fielddata.fieldId Typeinteger DescriptionField ID. See CRM fields and SPA fields
Fielddata.value Typestring DescriptionOption label
Fielddata.isDefault Typeboolean DescriptionUsed as a default option
Fielddata.sort Typeinteger DescriptionSort order
Fielddata.xmlId Typestring / null DescriptionExternal integration ID

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 4119,
    "fieldId": 6008145,
    "value": "VIBE-PROBE option",
    "isDefault": false,
    "sort": 500,
    "xmlId": "VIBE-PROBE-X"
  }
}

Error response example

400 — invalid request:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive safe integer"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionInvalid request shape or parameter type
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionUnknown or repeated query parameter
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo option exists with the specified ID
HTTP422 CodeMETHOD_NOT_YET_AVAILABLE DescriptionThe feature is not yet available. Update information is provided in error.release
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionInvalid response from Bitrix24
HTTP401 CodeMISSING_API_KEY DescriptionMissing X-Api-Key
HTTP401 CodeTOKEN_MISSING DescriptionNo Bitrix24 tokens are configured
HTTP403 CodeSCOPE_DENIED DescriptionThe key requires the crm scope

For shared API errors, see Errors.

See also