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
ParameteriblockId (path) Typestring Requiredyes Default— DescriptionList ID or symbolic code. Use the ID or CODE field from List of lists
ParametersectionId (path) Typenumber Requiredyes Default— DescriptionSection ID, a positive integer from the ID field returned by List sections
ParameteriblockTypeId (query) Typestring Requiredno Defaultlists DescriptionInfoblock type. Values:
lists — regular lists, the default
lists_socnet — workgroup lists
bitrix_processes — service workflows
structure — company structure type (contains the built-in absence calendar infoblock absence)
ParametersocnetGroupId (query) Typenumber Requiredno Default— DescriptionWorkgroup 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

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

curl — OAuth application

Terminal 
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

javascript 
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

javascript 
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
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionSection object
Fielddata.ID Typestring DescriptionSection ID from List sections
Fielddata.NAME Typestring DescriptionSection name
Fielddata.CODE Typestring or null DescriptionSection symbolic code, or null if not set
Fielddata.IBLOCK_ID Typestring DescriptionList ID from List of lists
Fielddata.IBLOCK_SECTION_ID Typestring or null DescriptionParent section ID from List sections. null for a root section
Fielddata.SORT Typestring DescriptionSort index
Fielddata.ACTIVE Typestring DescriptionThe section's own active state: Y or N
Fielddata.GLOBAL_ACTIVE Typestring DescriptionActive state accounting for parent sections: Y or N. If a parent is disabled, the descendant has N even when its own ACTIVE is Y
Fielddata.DEPTH_LEVEL Typestring DescriptionNesting level. 1 for a root section
Fielddata.LEFT_MARGIN Typestring DescriptionLeft boundary of the subtree in the nested set model
Fielddata.RIGHT_MARGIN Typestring DescriptionRight boundary of the subtree in the nested set model
Fielddata.DESCRIPTION Typestring or null DescriptionSection description, or null if not set
Fielddata.DESCRIPTION_TYPE Typestring DescriptionDescription format: text or html
Fielddata.DATE_CREATE Typestring or null DescriptionCreation date and time in the Bitrix24 account's format, or null if not set
Fielddata.CREATED_BY Typestring or null DescriptionID of the employee who created the section, from List employees, or null if not set
Fielddata.MODIFIED_BY Typestring or null DescriptionID of the employee who last modified the section, from List employees, or null if not set
Fielddata.TIMESTAMP_X Typestring DescriptionLast modification date and time in the Bitrix24 account's format
Fielddata.PICTURE Typestring or null DescriptionSection image file ID, or null if no image is set
Fielddata.DETAIL_PICTURE Typestring or null DescriptionSection detail image file ID, or null if no image is set
Fielddata.SEARCHABLE_CONTENT Typestring or null DescriptionSearch text generated from the section name and description, or null if not set
Fielddata.XML_ID Typestring or null DescriptionExternal section ID for data exchange, or null if not set
Fielddata.EXTERNAL_ID Typestring or null DescriptionThe same value as XML_ID
Fielddata.TMP_ID Typestring or null DescriptionTemporary section ID for internal operations, or null if not set
Fielddata.SOCNET_GROUP_ID Typestring or null DescriptionWorkgroup ID from List workgroups, or null if not set
Fielddata.LIST_PAGE_URL Typestring or null DescriptionList page URL template from the list settings, or null if not set
Fielddata.SECTION_PAGE_URL Typestring or null DescriptionSection page URL template from the list settings, or null if not set
Fielddata.IBLOCK_TYPE_ID Typestring DescriptionInfoblock type
Fielddata.IBLOCK_CODE Typestring or null DescriptionList symbolic code from List of lists, or null if not set
Fielddata.IBLOCK_EXTERNAL_ID Typestring or null DescriptionExternal list ID for data exchange, or null if not set

Response example

JSON 
{
  "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:

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

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionsectionId is not a positive integer
HTTP400 CodeINVALID_IBLOCK_TYPE DescriptioniblockTypeId is not one of lists, bitrix_processes, lists_socnet, structure
HTTP404 CodeSECTION_NOT_FOUND DescriptionNo section with the given sectionId was found
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionNo access to the list
HTTP422 CodeBITRIX_ERROR DescriptionThe 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"
HTTP409 CodeLISTS_MODULE_NOT_ENABLED DescriptionThe Lists module is not enabled on the portal
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the lists scope
HTTP401 CodeTOKEN_MISSING DescriptionThe 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.

See also