Получить раздел

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

Возвращает полные метаданные одного раздела списка по его числовому идентификатору.

Параметры

Параметр Тип Обяз. По умолч. Описание
iblockId (path) string да — Числовой IBLOCK_ID или символьный код списка. Идентификаторы доступны через GET /v1/lists
sectionId (path) number да — Числовой идентификатор раздела. Идентификаторы доступны через GET /v1/lists/:iblockId/sections
iblockTypeId (query) string нет lists Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы

Примеры

curl — личный ключ

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

curl — OAuth-приложение

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/sections/137 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/121/sections/137', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Раздел:', data.NAME)

JavaScript — OAuth-приложение

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

Поля ответа

Поля ответа — в форме Битрикс24: ключи в верхнем регистре через подчёркивание, числовые значения и флаги (Y/N) приходят строками, незаданные поля — null.

Поле Тип Описание
success boolean Всегда true при успехе
data.ID string Идентификатор раздела
data.NAME string Название раздела
data.CODE string Символьный код раздела
data.IBLOCK_ID string Идентификатор списка, которому принадлежит раздел
data.IBLOCK_SECTION_ID string Идентификатор родительского раздела. Приходит null у корневого раздела
data.SORT string Индекс сортировки
data.ACTIVE string Активность раздела: Y или N
data.GLOBAL_ACTIVE string Действующая активность с учётом родительских разделов: Y или N
data.DEPTH_LEVEL string Уровень вложенности. 1 у корневого раздела
data.LEFT_MARGIN string Левая граница поддерева в модели вложенных множеств
data.RIGHT_MARGIN string Правая граница поддерева в модели вложенных множеств
data.DESCRIPTION string Описание раздела
data.DESCRIPTION_TYPE string Формат описания: text или html
data.DATE_CREATE string Дата создания
data.CREATED_BY string Идентификатор сотрудника, создавшего раздел
data.MODIFIED_BY string Идентификатор сотрудника, изменившего раздел последним

Показаны основные поля. Объект раздела содержит и другие поля метаданных инфоблока Битрикс24.

Пример ответа

JSON 
{
  "success": true,
  "data": {
    "ID": "137",
    "NAME": "Документы отдела продаж",
    "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": "Описание раздела",
    "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"
  }
}

Пример ответа при ошибке

404 — раздел не найден:

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

Ошибки

HTTP Код Описание
400 INVALID_PARAMS sectionId не является положительным целым числом
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в допустимый набор
404 SECTION_NOT_FOUND Раздел с указанным sectionId не найден
403 BITRIX_ACCESS_DENIED Нет прав на список либо списка с таким идентификатором не существует
409 LISTS_MODULE_NOT_ENABLED Модуль «Списки» не подключён на портале
403 SCOPE_DENIED У API-ключа нет скоупа lists
401 TOKEN_MISSING У API-ключа нет настроенных токенов

Полный список общих ошибок API — Ошибки.

Известные особенности

Положение раздела в дереве задаётся тремя полями. DEPTH_LEVEL — уровень вложенности, 1 у корневого раздела. LEFT_MARGIN и RIGHT_MARGIN — границы поддерева в модели вложенных множеств. По ним Битрикс24 определяет потомков раздела: раздел является потомком другого, если его границы лежат внутри границ предка.

ACTIVE и GLOBAL_ACTIVE различаются. ACTIVE — собственная активность раздела. GLOBAL_ACTIVE учитывает родительские разделы: если родитель отключён, у потомка приходит GLOBAL_ACTIVE равный N даже при ACTIVE равном Y.

Смотрите также