## List 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`.

## Parameters

| Parameter | Type | Req. | Default | Description |
|----------|-----|:-----:|-----------|---------|
| `filter` | object | yes | — | Filtering conditions. The `filter[iblockId]` key is required — the catalog ID from [`GET /v1/catalogs`](/docs/entities/catalogs).<br>[Filtering syntax](/docs/filtering). Example: `?filter[iblockId]=25&filter[active]=true` |
| `select` | string | no | — | Field selection: `?select=iblockId,id,name,active`. If the parameter is passed, it must include `iblockId`. Without `select`, all product 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` is `true`.

## Examples

### curl — personal key

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

### curl — OAuth application

```bash
curl "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 |
|------|-----|---------|
| `success` | boolean | Always `true` on success |
| `data` | array | Array of products. The field set of an element — see [Product fields](./fields.md) |
| `meta.total` | number | Total number of records matching the filter |
| `meta.hasMore` | boolean | Whether 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 account 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:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "GET /v1/catalog-products requires filter fields: iblockId. Example: GET /v1/catalog-products?filter[iblockId]=..."
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `MISSING_REQUIRED_FILTER` | The required `filter[iblockId]` filter was not passed. The request is rejected before Bitrix24 is called — the message contains the name of the missing field and a call example |
| 422 | `BITRIX_ERROR` | The catalog with the specified `iblockId` was not found (`Iblock Not Found`) |
| 422 | `BITRIX_ERROR` | `select` was passed without `iblockId` (`Required select fields: iblockId`) |
| 400 | `UNKNOWN_FILTER_FIELD` | Filtering by a field the product does not have. The message contains the list of available fields |
| 400 | `UNKNOWN_SORT_FIELD` | Sorting by a field the product 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](/docs/errors).

## See also

- [Create a product](/docs/entities/catalog-products/create)
- [Get a product](/docs/entities/catalog-products/get)
- [Search products](/docs/entities/catalog-products/search)
- [Product fields](/docs/entities/catalog-products/fields)
- [Catalog prices](/docs/entities/catalog-prices)
- [Filtering syntax](/docs/filtering)
- [Entity reference](/docs/entities-index)