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, retrieve and filter. 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
Parameterlimit Typenumber Default50 DescriptionNumber of records (up to 5000). When limit > 50, the response is automatically assembled from several Bitrix24 pages
Parameteroffset Typenumber Default0 DescriptionHow many catalogs to skip from the start of the result: ?offset=1 starts from the second catalog
Parameterselect Typestring Default— DescriptionField selection: ?select=id,name. Only the listed fields are returned
Parametersort Typestring Default— DescriptionSort field. The - prefix means descending: ?sort=-id
Parameterorder Typeobject | string Default— DescriptionSorting in one of two forms.
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.
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
Parameterfilter Typeobject Default— DescriptionFilter by fields from GET /v1/catalogs/fields.
Filtering syntax. Example: ?filter[iblockTypeId]=CRM_PRODUCT_CATALOG
ParameterwithTotal Typestring Default— DescriptionIgnored: 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

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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of catalogs (all fields — see Catalog fields)
Fieldmeta.total Typenumber DescriptionTotal number of catalogs matching the filter. Not returned on an empty page with offset greater than zero
Fieldmeta.hasMore Typeboolean DescriptionWhether 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
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionFilter by a field the catalog does not have. The message contains the list of available fields
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionSort by a field the catalog does not have
HTTP400 CodeINVALID_SORT_DIRECTION DescriptionThe order map has a direction other than asc, desc, ASC or DESC
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not provided
HTTP429 CodeRATE_LIMITED DescriptionRate 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.

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 is more convenient — the filter is passed in the request body.

See also