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 a list section by its numeric ID.
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
iblockId (path) |
string | yes | — | List ID or symbolic code. Use the ID or CODE field from List of lists |
sectionId (path) |
number | yes | — | Section ID, a positive integer from the ID field returned by List sections |
iblockTypeId (query) |
string | no | lists |
Infoblock type. Values:lists — regular lists, the defaultlists_socnet — workgroup listsbitrix_processes — service workflowsstructure — company structure type (contains the built-in absence calendar infoblock absence) |
socnetGroupId (query) |
number | no | — | Workgroup ID for lists of type lists_socnet. A positive integer from the id field returned by List workgroups. Omit it for regular lists |
Examples
curl — personal key
curl https://vibecode.bitrix24.com/v1/lists/165/sections/259 \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth application
curl https://vibecode.bitrix24.com/v1/lists/165/sections/259 \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — personal key
const res = await fetch('https://vibecode.bitrix24.com/v1/lists/165/sections/259', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Section:', data.NAME)
JavaScript — OAuth application
const res = await fetch('https://vibecode.bitrix24.com/v1/lists/165/sections/259', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data } = await res.json()
Response fields
Numeric values and the Y/N flags are returned as strings. The response has no meta field.
| Field | Type | Description |
|---|---|---|
success |
boolean | Always true on success |
data |
object | Section object |
data.ID |
string | Section ID from List sections |
data.NAME |
string | Section name |
data.CODE |
string or null | Section symbolic code, or null if not set |
data.IBLOCK_ID |
string | List ID from List of lists |
data.IBLOCK_SECTION_ID |
string or null | Parent section ID from List sections. null for a root section |
data.SORT |
string | Sort index |
data.ACTIVE |
string | The section's own active state: Y or N |
data.GLOBAL_ACTIVE |
string | Active state accounting for parent sections: Y or N. If a parent is disabled, the descendant has N even when its own ACTIVE is Y |
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 or null | Section description, or null if not set |
data.DESCRIPTION_TYPE |
string | Description format: text or html |
data.DATE_CREATE |
string or null | Creation date and time in the Bitrix24 account's format, or null if not set |
data.CREATED_BY |
string or null | ID of the employee who created the section, from List employees, or null if not set |
data.MODIFIED_BY |
string or null | ID of the employee who last modified the section, from List employees, or null if not set |
data.TIMESTAMP_X |
string | Last modification date and time in the Bitrix24 account's format |
data.PICTURE |
string or null | Section image file ID, or null if no image is set |
data.DETAIL_PICTURE |
string or null | Section detail image file ID, or null if no image is set |
data.SEARCHABLE_CONTENT |
string or null | Search text generated from the section name and description, or null if not set |
data.XML_ID |
string or null | External section ID for data exchange, or null if not set |
data.EXTERNAL_ID |
string or null | The same value as XML_ID |
data.TMP_ID |
string or null | Temporary section ID for internal operations, or null if not set |
data.SOCNET_GROUP_ID |
string or null | Workgroup ID from List workgroups, or null if not set |
data.LIST_PAGE_URL |
string or null | List page URL template from the list settings, or null if not set |
data.SECTION_PAGE_URL |
string or null | Section page URL template from the list settings, or null if not set |
data.IBLOCK_TYPE_ID |
string | Infoblock type |
data.IBLOCK_CODE |
string or null | List symbolic code from List of lists, or null if not set |
data.IBLOCK_EXTERNAL_ID |
string or null | External list ID for data exchange, or null if not set |
Response example
{
"success": true,
"data": {
"ID": "259",
"TIMESTAMP_X": "10/07/2026 08:53:57 am",
"MODIFIED_BY": "1295",
"DATE_CREATE": "10/07/2026 08:53:57 am",
"CREATED_BY": "1295",
"IBLOCK_ID": "165",
"IBLOCK_SECTION_ID": null,
"ACTIVE": "Y",
"GLOBAL_ACTIVE": "Y",
"SORT": "100",
"NAME": "Sales department documents",
"PICTURE": null,
"LEFT_MARGIN": "1",
"RIGHT_MARGIN": "4",
"DEPTH_LEVEL": "1",
"DESCRIPTION": "Section description",
"DESCRIPTION_TYPE": "html",
"SEARCHABLE_CONTENT": "SALES DEPARTMENT DOCUMENTS\r\nSECTION DESCRIPTION",
"CODE": "sales_docs",
"XML_ID": null,
"TMP_ID": null,
"DETAIL_PICTURE": null,
"SOCNET_GROUP_ID": null,
"LIST_PAGE_URL": null,
"SECTION_PAGE_URL": null,
"IBLOCK_TYPE_ID": "lists",
"IBLOCK_CODE": "sales_documents",
"IBLOCK_EXTERNAL_ID": null,
"EXTERNAL_ID": null
}
}
Error response example
404 — section not found:
{
"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 one of lists, bitrix_processes, lists_socnet, structure |
| 404 | SECTION_NOT_FOUND |
No section with the given sectionId was found |
| 403 | BITRIX_ACCESS_DENIED |
No access to the list |
| 422 | BITRIX_ERROR |
The list does not exist or its type does not match the request parameters, for example, when socnetGroupId is passed for a regular list. The response contains b24Code: "0" |
| 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 is a descendant of another if its LEFT_MARGIN and RIGHT_MARGIN fall within the ancestor's boundaries. This lets you determine nesting from the subtree boundaries.