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

List catalog products

GET /v1/catalog-products

Returns a list of catalog products with support for filtering, sorting, field selection, and pagination. Requires the filter[iblockId] filter — the catalog to select products from. Without this filter, the request returns 400.

The dateCreate, timestampX, dateActiveFrom, and dateActiveTo fields are not accepted in filter: the request returns 400 UNKNOWN_FILTER_FIELD before calling Bitrix24. These dates remain available in select and responses.

Parameters

Parameter	Type	Required	Default	Description
Parameter`filter`	Typeobject	Requiredyes	Default—	DescriptionFiltering conditions. The `filter[iblockId]` key is required — the catalog ID from `GET /v1/catalogs`. Filtering syntax. Example: `?filter[iblockId]=25&filter[active]=true`
Parameter`select`	Typestring	Requiredno	Default—	DescriptionField selection: `?select=iblockId,id,name,active`. If the parameter is passed, it must include `iblockId`. Without `select`, the response carries a reduced set of fields: the symbolic code, dimensions, text fields, and several other fields are returned only when explicitly selected — Catalog product fields lists which ones. A custom catalog property is not part of the field reference and is requested by its own name: `?select=iblockId,id,name,property295`
Parameter`sort`	Typestring	Requiredno	Default—	DescriptionSort field. The `-` prefix means descending: `?sort=-id`
Parameter`limit`	Typenumber	Requiredno	Default`50`	DescriptionNumber of records (up to 5000)
Parameter`offset`	Typenumber	Requiredno	Default`0`	DescriptionOffset 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 is true.

Examples

curl — personal key

Terminal

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

curl — OAuth application

Terminal

curl -g "https://vibecode.bitrix24.com/v1/catalog-products?filter[iblockId]=25&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]': '25', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-products?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

javascript

const params = new URLSearchParams({ 'filter[iblockId]': '25', limit: '10' })
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-products?${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
Field`success`	Typeboolean	DescriptionAlways `true` on success
Field`data`	Typearray	DescriptionArray of products. For the fields of each item, see Catalog product fields
Field`meta.total`	Typenumber	DescriptionTotal number of records matching the filter
Field`meta.hasMore`	Typeboolean	DescriptionWhether there are more records beyond `limit`

The card URL of any product from the data array is built from its iblockId and id:

https://<portal>.bitrix24.com/shop/catalog/<iblockId>/product/<id>/

<portal> is the Bitrix24 portal domain. Access is restricted by the employee's permissions in Bitrix24.

Response example

JSON

{
  "success": true,
  "data": [
    {
      "id": 533,
      "iblockId": 25,
      "iblockSectionId": 19,
      "name": "Desktop speaker",
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "measure": 9,
      "purchasingCurrency": "USD",
      "purchasingPrice": 0,
      "quantity": null,
      "quantityTrace": true,
      "subscribe": true,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false,
      "dateCreate": "2021-07-20T10:01:36.000Z",
      "timestampX": "2023-08-21T08:12:18.000Z"
    },
    {
      "id": 541,
      "iblockId": 25,
      "iblockSectionId": null,
      "name": "USB-C cable",
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "measure": 9,
      "purchasingCurrency": "USD",
      "purchasingPrice": 110,
      "quantity": null,
      "quantityTrace": false,
      "subscribe": true,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false,
      "dateCreate": "2021-08-06T12:59:15.000Z",
      "timestampX": "2025-10-31T10:24:18.000Z"
    }
  ],
  "meta": {
    "total": 19,
    "hasMore": false
  }
}

Error response example

400 — the required filter was not passed: