## List of catalogs

`GET /v1/catalogs`

Returns a list of the Bitrix24 account's product catalogs with support for filtering, sorting and field selection.

## Parameters

| Parameter | Type | Default | Description |
|----------|-----|-----------|---------|
| `limit` | number | `50` | Number of records (up to 5000). When `limit > 50`, the response is automatically assembled from several Bitrix24 pages |
| `offset` | number | `0` | How many catalogs to skip from the start of the result: `?offset=1` starts from the second catalog |
| `select` | string | — | Field selection: `?select=id,name`. Only the listed fields are returned |
| `sort` | string | — | Sort field. The `-` prefix means descending: `?sort=-id` |
| `order` | object \| string | — | Sorting in one of two forms.<br>Field and direction: `?order[id]=desc`. Takes the same fields as `sort`. Applies only when `sort` is not passed. The direction is `asc`, `desc`, `ASC` or `DESC`; any other value returns `400 INVALID_SORT_DIRECTION`.<br>Direction only: `?sort=id&order=desc`. Works together with `sort` and switches its fields without the `-` prefix to descending. A field with `-` stays descending even with `order=asc`. Without `sort`, or with a value other than `asc` and `desc`, it has no effect |
| `filter` | object | — | Filter by fields from `GET /v1/catalogs/fields`.<br>[Filtering syntax](/docs/filtering). Example: `?filter[iblockTypeId]=CRM_PRODUCT_CATALOG` |
| `withTotal` | string | — | Ignored: the count cannot be turned off for catalogs, so `meta.total` arrives just as it does without the parameter, for any value, including `false`. [Paging and record counts](/docs/entity-api#paging-and-record-counts) |

## Examples

### curl — personal key

```bash
curl "https://vibecode.bitrix24.com/v1/catalogs" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth application

```bash
curl "https://vibecode.bitrix24.com/v1/catalogs" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — personal key

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/catalogs', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/catalogs', {
  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 catalogs (all fields — see [Catalog fields](/docs/entities/catalogs/fields)) |
| `meta.total` | number | Total number of catalogs matching the filter. Not returned on an empty page with `offset` greater than zero |
| `meta.hasMore` | boolean | Whether there are more records beyond `limit` |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": 25,
      "iblockId": 25,
      "iblockTypeId": "CRM_PRODUCT_CATALOG",
      "lid": "s1",
      "name": "CRM product catalog",
      "productIblockId": null,
      "skuPropertyId": null,
      "subscription": "N",
      "vatId": 1,
      "yandexExport": false
    },
    {
      "id": 27,
      "iblockId": 27,
      "iblockTypeId": "CRM_PRODUCT_CATALOG",
      "lid": "s1",
      "name": "CRM product catalog (offers)",
      "productIblockId": 25,
      "skuPropertyId": 101,
      "subscription": "N",
      "vatId": 1,
      "yandexExport": false
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}
```

## Error response example

400 — filter by a non-existent field:

```json
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'nonExistentField' for entity 'catalogs'. Available: id, iblockId, iblockTypeId, lid, name, productIblockId, skuPropertyId, subscription, vatId, yandexExport"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `UNKNOWN_FILTER_FIELD` | Filter by a field the catalog does not have. The message contains the list of available fields |
| 400 | `UNKNOWN_SORT_FIELD` | Sort by a field the catalog does not have |
| 400 | `INVALID_SORT_DIRECTION` | The `order` map has a direction other than `asc`, `desc`, `ASC` or `DESC` |
| 403 | `SCOPE_DENIED` | The API key does not have the `catalog` scope |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header was not provided |
| 429 | `RATE_LIMITED` | Rate 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](/docs/errors).

## Known specifics

**Product catalog or offers catalog.** Use `productIblockId` and `skuPropertyId` to identify the catalog type: both are `null` for a base product catalog and populated for an offers catalog. For an offers catalog, `productIblockId` is the `iblockId` of the linked product catalog.

**When to use search instead of list:** for conditions on multiple fields, [`POST /v1/catalogs/search`](./search.md) is more convenient — the filter is passed in the request body.

## See also

- [Get a catalog](/docs/entities/catalogs/get)
- [Search catalogs](/docs/entities/catalogs/search)
- [Catalog fields](/docs/entities/catalogs/fields)
- [Catalog products](/docs/entities/catalog-products)
- [Filtering syntax](/docs/filtering)
- [API reference](/docs/api-reference)