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

List SKUs

GET /v1/catalog-skus

Returns the parent products of a catalog with support for filtering, sorting, field selection, and pagination. Requires the filter[iblockId] filter — the product catalog to select from. Without this filter, the request returns 400.

The dateCreate, timestampX, dateActiveFrom, and dateActiveTo fields are not accepted in filter: the request returns 400 UNKNOWN_FILTER_FIELD before calling Bitrix24. These dates remain available in select and responses.

Parameters

Parameter Type Required Default Description
Parameterfilter Typeobject Requiredyes Default— DescriptionFiltering conditions. The filter[iblockId] key is required — the product catalog ID from GET /v1/catalogs. The filter[type] filter accepts one exact number: 3 — parent products with offers, 6 — without offers.
Filtering syntax. Example: ?filter[iblockId]=25&filter[type]=3
Parameterselect Typestring Requiredno Default— DescriptionField selection: ?select=iblockId,id,name,type. If the parameter is passed, it must include iblockId and id. Without select, the response carries a reduced set of fields: the symbolic code, texts, sort order, and external code are returned only when listed explicitly — SKU fields lists which ones. A catalog property is requested by its own name: ?select=iblockId,id,name,property295
Parametersort Typestring Requiredno Default— DescriptionSort field. The - prefix means descending: ?sort=-id
Parameterlimit Typenumber Requiredno Default50 DescriptionNumber of records (up to 5000)
Parameteroffset Typenumber Requiredno Default0 DescriptionOffset 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

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/catalog-skus?filter[iblockId]=25&filter[type]=3&sort=-id&limit=2" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g "https://vibecode.bitrix24.com/v1/catalog-skus?filter[iblockId]=25&filter[type]=3&sort=-id&limit=2" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const params = new URLSearchParams({
  'filter[iblockId]': '25',
  'filter[type]': '3',
  sort: '-id',
  limit: '2',
})
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-skus?${params}`, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

javascript 
const params = new URLSearchParams({
  'filter[iblockId]': '25',
  'filter[type]': '3',
  sort: '-id',
  limit: '2',
})
const res = await fetch(`https://vibecode.bitrix24.com/v1/catalog-skus?${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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of parent products. For the fields of each item, see SKU fields
Fieldmeta.total Typenumber DescriptionTotal number of records matching the filter
Fieldmeta.hasMore Typeboolean DescriptionWhether there are more records beyond limit
Fieldmeta.warnings Typearray DescriptionWarnings about select. Present when select contains a name that is not in the field reference: the array then holds an item { code: "UNKNOWN_SELECT_FIELD", message, field }, and no value for that name is included in the response

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": 7205,
      "iblockId": 25,
      "iblockSectionId": 19,
      "name": "Basic hoodie",
      "type": 3,
      "active": true,
      "available": true,
      "bundle": false,
      "createdBy": 1295,
      "modifiedBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:45:34.000Z",
      "timestampX": "2026-10-08T18:45:36.000Z"
    },
    {
      "id": 7203,
      "iblockId": 25,
      "iblockSectionId": null,
      "name": "Basic T-shirt",
      "type": 3,
      "active": true,
      "available": true,
      "bundle": false,
      "createdBy": 1295,
      "modifiedBy": 1295,
      "dateActiveFrom": null,
      "dateActiveTo": null,
      "dateCreate": "2026-10-08T18:45:34.000Z",
      "timestampX": "2026-10-08T18:45:35.000Z"
    }
  ],
  "meta": {
    "total": 14,
    "hasMore": true
  }
}

Error response example

400 — the required filter was not passed:

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

Errors

HTTP Code Description
HTTP400 CodeMISSING_REQUIRED_FILTER DescriptionThe 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
HTTP400 CodeUNSUPPORTED_FILTER Descriptionfilter[type] was passed as something other than a single number 3 or 6 — another number, an operator, or an array
HTTP422 CodeBITRIX_ERROR DescriptioniblockId points to an offer catalog (productType is not allowed for this catalog)
HTTP422 CodeBITRIX_ERROR DescriptioniblockId is not a catalog (iblock is not catalog)
HTTP422 CodeBITRIX_ERROR Descriptionselect was passed without iblockId (Required select fields: iblockId)
HTTP422 CodeBITRIX_ERROR Descriptionselect was passed without id (Required select fields: id)
HTTP400 CodeUNKNOWN_FILTER_FIELD DescriptionUnknown filter field or a date field: dateCreate, timestampX, dateActiveFrom, dateActiveTo. The message contains the list of available fields
HTTP400 CodeUNKNOWN_SORT_FIELD DescriptionSorting by a field the parent product does not have. The message contains the list of available fields
HTTP403 CodeSCOPE_DENIED DescriptionThe API key does not have the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not passed
HTTP429 CodeCALLER_RATE_LIMITED DescriptionThe shared caller limit for this API key or its owner has been reached. The response has Retry-After and X-RateLimit-Scope; it does not expose the effective limit in x-ratelimit-limit
HTTP429 CodeRATE_LIMITED DescriptionThe request limit was exceeded: 300 requests per minute per portal, shared by all API keys of the portal. The effective value 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

A parent product without offers leaves the list. When the last offer of a parent product is deleted, Bitrix24 turns it into a regular product with type: 1. Such a product is no longer returned by GET /v1/catalog-skus and is read through GET /v1/catalog-products.

See also