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

Catalogs

Commercial catalogs of your Bitrix24 account: list, retrieval and filtering. A catalog defines the iblockId used by products, sections and prices. Catalogs are read-only.

Bitrix24 API: catalog.catalog.* Scope: catalog

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
select string — Field selection: ?select=id,name. Only the listed fields are returned
sort string — Sort field. The - prefix means descending: ?sort=-id
filter object — Filtering by GET /v1/catalogs/fields fields.
Filtering syntax. Example: ?filter[iblockTypeId]=CRM_PRODUCT_CATALOG

Examples

curl — personal key

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

curl — OAuth application

Terminal 
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)
meta.total number Total number of catalogs matching the filter
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
403 SCOPE_DENIED The API key does not have the catalog scope
401 MISSING_API_KEY The X-Api-Key header was not provided

Full list of common API errors — Errors.

Known specifics

Products catalog or offers catalog. The catalog type in the output is visible from the productIblockId and skuPropertyId fields: in a base products catalog both are null; in an offers catalog they are populated, where productIblockId is the iblockId of the linked products catalog.

When to use search instead of list: for conditions across multiple fields it is more convenient to use POST /v1/catalogs/search — the filter is passed in the request body.

See also