Value fields

GET /v1/catalog-product-property-enums/fields

Returns the field reference of an enumeration element with types and field write permissions, plus the operations available in a batch request.

The response is assembled from the static entity schema — Bitrix24 is not called.

Examples

curl — personal key

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

curl — OAuth application

curl "https://vibecode.bitrix24.com/v1/catalog-product-property-enums/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-product-property-enums/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Fields:', Object.keys(data.fields).length)

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/catalog-product-property-enums/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

data.fields is an object whose key matches the field name and whose value carries type, readonly, and the human-readable label and description. data.batch lists the write operations available in a batch request; for this entity it contains create, update, and delete. That does not rule out reads in a batch: the list and get sub-calls through POST /v1/batch and POST /v1/catalog-product-property-enums/batch work. The fields sub-call is accepted in a batch too, but for this entity it answers 200 with an empty object — Bitrix24 is not called and the field reference cannot be obtained that way. Fetch it with a standalone GET /v1/catalog-product-property-enums/fields request.

The label and description field captions are returned in English. Request headers do not switch the language.

Response example

label and description are shown for the first field only and omitted elsewhere for brevity.

{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID",
        "description": "Identifier of the enumeration element. This is the value that a product's propertyNNN.value carries."
      },
      "propertyId": { "type": "number" },
      "value": { "type": "string" },
      "def": { "type": "boolean" },
      "sort": { "type": "number" },
      "xmlId": { "type": "string", "nullable": true }
    },
    "batch": ["create", "update", "delete"]
  }
}

Error response example

403 — no scope:

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

Errors

Full list of common API errors — Errors.

Known specifics

Only id is read-only. POST, PATCH, and DELETE are available; POST /aggregate remains unavailable. data.batch contains the three write actions. Read sub-calls in a batch request remain available.

Only properties of type L have an enumeration. For a property of any other type (S, N, F, E, G) the option list is empty, and a write is rejected by Bitrix24. The property type is read from GET /v1/catalog-product-properties/:id in the propertyType field.

Relation to product fields. A list-property value arrives on a catalog product in the field propertyNNN, where NNN is the property id. Inside are value (the enumeration element id, as a string), valueEnum (the ready-made text), and valueId (the value row id). Match with String(element.id) === product.propertyNNN.value.

See also

• List values
• Get a value
• Search values
• Catalog product properties
• Catalog products
• API reference