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

Get a catalog

GET /v1/catalogs/:id

Returns a single commercial catalog by identifier with all fields.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionCatalog ID

Examples

curl — personal key

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

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/catalogs/25" \
  -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/25', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Catalog:', data.name, '— iblockId', data.iblockId)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/catalogs/25', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue when the request succeeds
Fielddata Typeobject DescriptionThe catalog with all fields: id, iblockId, iblockTypeId, lid, name, productIblockId, skuPropertyId, subscription, vatId, yandexExport. Each field is described in Catalog fields

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
  }
}

Error response example

404 — catalog not found:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "catalog does not exist."
  }
}

Errors

HTTP Code Description
HTTP404 CodeENTITY_NOT_FOUND DescriptionNo catalog with this id — the message is "catalog does not exist.". The same response is returned for a non-numeric id
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not provided

Full list of common API errors — Errors.

Known specifics

Products catalog or offers catalog. The catalog type 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.

See also