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 Req. Default Description
filter object no — Filtering 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
select string no — Field selection: ?select=id,name,propertyType. Without select, all property fields are returned
sort string no — Sort field. The - prefix means descending: ?sort=-id
limit number no 50 Number of records (up to 5000)
offset number no 0 Offset from the start of the selection

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 returns true.

Examples

curl — personal key

Terminal 
curl "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 "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
success boolean Always true on success
data array Array of properties. The field set of an element — see Property fields
meta.total number Total number of records matching the filter
meta.hasMore boolean Whether 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 selection turns NNN into a name and a 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": "Needle length",
      "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": "RU registration name",
      "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
422 BITRIX_ERROR The catalog from filter[iblockId] was not found (Iblock Not Found)
400 UNKNOWN_FILTER_FIELD Filtering by a field the property does not have. The message contains the list of available fields
400 UNKNOWN_SORT_FIELD Sorting by a field the property does not have. The message contains the list of available fields
403 SCOPE_DENIED The API key does not have the catalog scope
401 MISSING_API_KEY The X-Api-Key header was not passed

Full list of common API errors — Errors.

See also