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 ID.

Parameters

Parameter Type Required Description
Parameterid (path) Typenumber Requiredyes DescriptionSection 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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionCatalog section object
Fielddata.id Typenumber DescriptionSection identifier
Fielddata.iblockId Typenumber DescriptionID of the catalog the section belongs to. List: GET /v1/catalogs
Fielddata.iblockSectionId Typenumber | null DescriptionID of the parent section. null — top-level section. List: GET /v1/catalog-sections
Fielddata.name Typestring DescriptionSection name
Fielddata.code Typestring | null DescriptionSection symbolic code
Fielddata.xmlId Typestring | null DescriptionExternal identifier
Fielddata.sort Typenumber DescriptionSort index
Fielddata.active Typeboolean DescriptionWhether the section is active
Fielddata.description Typestring | null DescriptionSection description
Fielddata.descriptionType Typestring DescriptionDescription 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
HTTP422 CodeBITRIX_ERROR DescriptionA section with the given id does not exist or is not accessible — Bitrix24 responds with Access Denied
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the catalog scope
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not provided

Full list of common API errors — Errors.

See also