For AI agents: markdown of this page — /docs-content-en/entities/catalog-product-property-enums/get.md documentation index — /llms.txt

Get a value

GET /v1/catalog-product-property-enums/:id

Returns one option of a list property by the enumeration element identifier. This is the same id a catalog product carries in propertyNNN.value.

Parameters

Parameter Type Req. Description
id (path) number yes Identifier of the enumeration element

No propertyId filter is needed here: the element is addressed by its own identifier.

Examples

curl — personal key

Terminal 
curl "https://vibecode.bitrix24.com/v1/catalog-product-property-enums/116" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/catalog-product-property-enums/116" \
  -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/catalog-product-property-enums/116', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Value:', data.value)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-product-property-enums/116', {
  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 option object. The field set — see Value fields

xmlId comes back as null when no external code is set.

A single option is read directly when its id is already known — taken, for example, from a product's propertyNNN.value. To get all options of a property, use the list with filter[propertyId].

Response example

JSON 
{
  "success": true,
  "data": {
    "id": 116,
    "propertyId": 166,
    "value": "L",
    "def": false,
    "sort": 400,
    "xmlId": null
  }
}

Error response example

404 — no element with that id:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "catalogProductPropertyEnum 116 not found"
  }
}

Errors

HTTP Code Description
404 ENTITY_NOT_FOUND No enumeration element with the given id exists
403 SCOPE_DENIED The API key does not carry the catalog scope
401 MISSING_API_KEY The X-Api-Key header was not sent

Full list of common API errors — Errors.

See also