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

Get section

GET /v1/lists/:iblockId/sections/:sectionId

Returns the full metadata of a single list section by its numeric id.

Parameters

Parameter Type Req. Default Description
iblockId (path) string yes — Numeric IBLOCK_ID or the list's symbolic code. Ids are available via GET /v1/lists
sectionId (path) number yes — Numeric section id. Ids are available via GET /v1/lists/:iblockId/sections
iblockTypeId (query) string no lists Infoblock type. Values:
lists — regular lists, default
lists_socnet — workgroup lists
bitrix_processes — workflow service type

Examples

curl — personal key

Terminal 
curl https://vibecode.bitrix24.com/v1/lists/121/sections/137 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl https://vibecode.bitrix24.com/v1/lists/121/sections/137 \
  -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/lists/121/sections/137', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Section:', data.NAME)

JavaScript — OAuth application

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

Response fields

Response fields are in Bitrix24 form: upper-case keys with underscores, numeric values and flags (Y/N) arrive as strings, unset fields are null.

Field Type Description
success boolean Always true on success
data.ID string Section id
data.NAME string Section name
data.CODE string Section symbolic code
data.IBLOCK_ID string Id of the list the section belongs to
data.IBLOCK_SECTION_ID string Parent section id. Arrives null for a root section
data.SORT string Sort index
data.ACTIVE string Section activity: Y or N
data.GLOBAL_ACTIVE string Effective activity accounting for parent sections: Y or N
data.DEPTH_LEVEL string Nesting level. 1 for a root section
data.LEFT_MARGIN string Left boundary of the subtree in the nested set model
data.RIGHT_MARGIN string Right boundary of the subtree in the nested set model
data.DESCRIPTION string Section description
data.DESCRIPTION_TYPE string Description format: text or html
data.DATE_CREATE string Creation date
data.CREATED_BY string Id of the employee who created the section
data.MODIFIED_BY string Id of the employee who last modified the section

The main fields are shown. The section object also contains other Bitrix24 infoblock metadata fields.

Response example

JSON 
{
  "success": true,
  "data": {
    "ID": "137",
    "NAME": "Sales department documents",
    "CODE": "sales_docs",
    "IBLOCK_ID": "121",
    "IBLOCK_SECTION_ID": null,
    "ACTIVE": "Y",
    "GLOBAL_ACTIVE": "Y",
    "SORT": "100",
    "DEPTH_LEVEL": "1",
    "LEFT_MARGIN": "1",
    "RIGHT_MARGIN": "2",
    "DESCRIPTION": "Section description",
    "DESCRIPTION_TYPE": "html",
    "DATE_CREATE": "10/22/2025 04:22:38 am",
    "CREATED_BY": "1",
    "MODIFIED_BY": "1",
    "TIMESTAMP_X": null,
    "PICTURE": null,
    "IBLOCK_TYPE_ID": "lists"
  }
}

Error response example

404 — section not found:

JSON 
{
  "success": false,
  "error": {
    "code": "SECTION_NOT_FOUND",
    "message": "Section not found"
  }
}

Errors

HTTP Code Description
400 INVALID_PARAMS sectionId is not a positive integer
400 INVALID_IBLOCK_TYPE iblockTypeId is not in the allowed set
404 SECTION_NOT_FOUND No section with the given sectionId
403 BITRIX_ACCESS_DENIED No access to the list, or a list with this id does not exist
409 LISTS_MODULE_NOT_ENABLED The "Lists" module is not enabled on the portal
403 SCOPE_DENIED The API key lacks the lists scope
401 TOKEN_MISSING The API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

A section's position in the tree is defined by three fields. DEPTH_LEVEL is the nesting level, 1 for a root section. LEFT_MARGIN and RIGHT_MARGIN are the subtree boundaries in the nested set model. Bitrix24 uses them to determine a section's descendants: a section is a descendant of another if its boundaries lie within the ancestor's boundaries.

ACTIVE and GLOBAL_ACTIVE differ. ACTIVE is the section's own activity. GLOBAL_ACTIVE accounts for parent sections: if a parent is disabled, the descendant's GLOBAL_ACTIVE arrives as N even when ACTIVE is Y.

See also