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

List properties

GET /v1/catalog-product-properties

Returns a list of catalog product properties with support for filtering, sorting, field selection, and pagination. The filter[iblockId] filter scopes the selection to a single catalog.

Parameters

Parameter Type Required Default Description
Parameterfilter Typeobject Requiredno Default— DescriptionFiltering conditions. The filter[iblockId] key scopes the selection to a single catalog — the catalog ID from GET /v1/catalogs.
Filtering syntax. Example: ?filter[iblockId]=19&filter[active]=true
Parameterselect Typestring Requiredno Default— DescriptionField selection: ?select=id,name,propertyType. Without select, all property fields are returned
Parametersort Typestring Requiredno Default— DescriptionSort field. The - prefix means descending: ?sort=-id
Parameterorder Typeobject | string Requiredno Default— DescriptionSorting in object form: ?order[id]=desc, with the direction asc, desc, ASC, or DESC. Any other value returns 400 INVALID_SORT_DIRECTION. Applied only when sort is not sent. The short form order=desc works only together with sort: ?sort=id&order=desc switches the fields listed in sort from ascending to descending. Without sort, the short form is ignored
Parameterlimit Typenumber Requiredno Default50 DescriptionNumber of records (up to 5000)
Parameteroffset Typenumber Requiredno Default0 DescriptionOffset from the start of the selection
ParameterwithTotal Typestring Requiredno Default— DescriptionAccepts true or false. For this entity the parameter is ignored: meta.total is returned even with withTotal=false

For limit > 50, the response is automatically assembled from several pages on the server side. The maximum is 5000 records per call. If more records match the filter than were returned, meta.hasMore is true.

Examples

curl — personal key

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/catalog-product-properties?filter[iblockId]=19&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/catalog-product-properties?filter[iblockId]=19&limit=10" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const params = new URLSearchParams({ 'filter[iblockId]': '19', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-product-properties?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Properties: ${meta.total}`)

JavaScript — OAuth application

javascript 
const params = new URLSearchParams({ 'filter[iblockId]': '19', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-product-properties?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of properties. For the fields of each element, see Property fields
Fieldmeta.total Typenumber DescriptionTotal number of records matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether there are more records beyond limit

List-type (L) properties of a product from Catalog products come back as fields named propertyNNN, where NNN is the id of the property. This list resolves NNN to a property name and type. Building an id → name map lets you label the propertyNNN field values:

propertyNNN  →  data[i].id === NNN  →  data[i].name, data[i].propertyType

Access is restricted by the employee's permissions in Bitrix24.

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 152,
      "iblockId": 19,
      "name": "Product characteristics",
      "active": true,
      "code": "CHARS",
      "propertyType": "L",
      "listType": "L",
      "multiple": true,
      "sort": 500,
      "userType": null,
      "userTypeSettings": null,
      "isRequired": false,
      "searchable": false,
      "filtrable": false,
      "xmlId": null,
      "timestampX": "2026-03-19T18:23:02.000Z"
    },
    {
      "id": 154,
      "iblockId": 19,
      "name": "Name per registration certificate",
      "active": true,
      "code": "NAME_RU",
      "propertyType": "S",
      "listType": null,
      "multiple": false,
      "sort": 510,
      "userType": null,
      "userTypeSettings": null,
      "isRequired": false,
      "searchable": false,
      "filtrable": false,
      "xmlId": null,
      "timestampX": "2026-03-19T18:23:02.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

Error response example

422 — the catalog from the filter was not found:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Iblock Not Found"
  }
}

Errors

HTTP Code Description
HTTP422 CodeBITRIX_ERROR DescriptionThe catalog from filter[iblockId] was not found (Iblock Not Found)
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionFiltering by a field the property does not have. The message contains the list of available fields
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionSorting by a field the property does not have. The message contains the list of available fields
HTTP400 CodeINVALID_SORT_DIRECTION DescriptionThe direction in order is not asc, desc, ASC, or DESC
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not passed
HTTP429 CodeRATE_LIMITED DescriptionRate limit exceeded: 300 requests per minute per portal. All API keys of the portal share one limit. The current limit is returned in the x-ratelimit-limit header. Retry after the delay in the Retry-After header

For the full list of common API errors, see Errors.

See also