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

List sections

GET /v1/catalog-sections

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

Parameters

Parameter Type Req. Default Description
filter object yes — Filtering conditions. The filter[iblockId] key is required — the catalog ID from GET /v1/catalogs.
Filtering syntax. Example: ?filter[iblockId]=25
select string no — Field selection: ?select=id,name,sort. Only the listed fields are returned
sort string no — Sort field. The - prefix means descending order: ?sort=-sort
limit number no 50 Number of records (up to 5000)
offset number no 0 Offset from the start of the selection

To select sections of a single parent, add filter[iblockSectionId].

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 "https://vibecode.bitrix24.com/v1/catalog-sections?filter[iblockId]=25" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl "https://vibecode.bitrix24.com/v1/catalog-sections?filter[iblockId]=25" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const url = 'https://vibecode.bitrix24.com/v1/catalog-sections?filter[iblockId]=25'
const res = await fetch(url, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

JavaScript — OAuth application

javascript 
const url = 'https://vibecode.bitrix24.com/v1/catalog-sections?filter[iblockId]=25'
const res = await fetch(url, {
  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 sections
data[].id number Section identifier
data[].iblockId number ID of the catalog the section belongs to
data[].iblockSectionId number | null Parent section ID. null — top-level section
data[].name string Section name
data[].code string | null Section symbolic code
data[].xmlId string | null External identifier
data[].sort number Sort index
data[].active boolean Whether the section is active
data[].description string | null Section description
data[].descriptionType string Description format: text or html
meta.total number Total number of records matching the filter
meta.hasMore boolean Whether there are more records beyond limit

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "active": true,
      "code": "clothes",
      "description": null,
      "descriptionType": "text",
      "iblockId": 25,
      "iblockSectionId": null,
      "id": 31,
      "name": "Clothing",
      "sort": 50,
      "xmlId": null
    },
    {
      "active": true,
      "code": "shoes",
      "description": null,
      "descriptionType": "text",
      "iblockId": 25,
      "iblockSectionId": 31,
      "id": 35,
      "name": "Footwear",
      "sort": 100,
      "xmlId": null
    }
  ],
  "meta": {
    "total": 37,
    "hasMore": false
  }
}

Error response example

400 — filter on a non-existent field:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'bogus' for entity 'catalog-sections'. Available: id, iblockId, iblockSectionId, name, xmlId, code, sort, active, description, descriptionType"
  }
}

Errors

HTTP Code Description
400 MISSING_REQUIRED_FILTER The 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
400 UNKNOWN_FILTER_FIELD Filtering by a field the section does not have. The message contains the list of available fields
400 UNKNOWN_SORT_FIELD Sorting by a field the section 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.

See also