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

Get a section

GET /v1/catalog-sections/:id

Returns a single catalog section by identifier.

Parameters

Parameter Type Required Description
id (path) number yes Section identifier

Examples

curl — personal key

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

curl — OAuth application

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

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

JavaScript — OAuth application

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

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

Response fields

Field Type Description
success boolean Always true on success
data.id number Section identifier
data.iblockId number ID of the catalog the section belongs to
data.iblockSectionId number | null ID of the parent section. 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

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

Error response example

422 — no section with this id:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Access Denied"
  }
}

Errors

HTTP Code Description
422 BITRIX_ERROR A section with the given id does not exist or is not accessible — Bitrix24 responds with Access Denied
403 SCOPE_DENIED The API key lacks the catalog scope
401 MISSING_API_KEY The X-Api-Key header was not provided

Full list of common API errors — Errors.

See also