Для AI-агентов: markdown этой страницы — /docs-content/lists/sections/list.md индекс документации — /llms.txt

Разделы списка

GET /v1/lists/:iblockId/sections

Возвращает разделы указанного списка. Разделы группируют элементы и могут образовывать дерево — у раздела бывает родительский раздел.

Параметры

Параметр Тип Обяз. По умолч. Описание
iblockId (path) string да — Идентификатор или символьный код списка. Значения — поля ID или CODE метода Список списков
iblockTypeId (query) string нет lists Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы
structure — тип структуры компании (здесь лежит штатный инфоблок графика отсутствий absence)
socnetGroupId (query) number нет — Идентификатор рабочей группы для списков типа lists_socnet. Положительное целое число из поля id метода Список рабочих групп. Для обычного списка не передавайте
filter (query) object нет — Фильтр по полям раздела, например ID, NAME, CODE, ACTIVE, GLOBAL_ACTIVE. Передавайте все условия одним JSON-объектом или в скобочной форме: ?filter={"NAME":"Счета"} либо ?filter[NAME]=Счета. Пустое ?filter= означает «без фильтра». Смешение форм и скобочная вложенность глубже двух уровней дают 400 INVALID_FILTER. Неизвестные имена и имена с операторами, например >ID, игнорируются
filter.SECTION_ID number нет — Идентификатор родительского раздела из поля ID этого метода. Отбирает непосредственные дочерние разделы. 0 — корневые разделы. Поле ответа IBLOCK_SECTION_ID и поле SORT в фильтре не работают: условия с этими именами игнорируются
select (query) string нет — Список возвращаемых полей через запятую. Пример: ?select=ID,NAME,CODE,IBLOCK_SECTION_ID,SORT. Неизвестные имена игнорируются. Если ни одно имя не распознано или select не задан, возвращается полный объект раздела

Примеры

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

Terminal 
curl 'https://vibecode.bitrix24.tech/v1/lists/167/sections?select=ID,NAME,CODE,IBLOCK_SECTION_ID,SORT' \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl 'https://vibecode.bitrix24.tech/v1/lists/167/sections?select=ID,NAME,CODE,IBLOCK_SECTION_ID,SORT' \
  -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/167/sections?select=ID,NAME,CODE,IBLOCK_SECTION_ID,SORT', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data, meta } = await res.json()
console.log('Разделов:', meta.total)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/167/sections?select=ID,NAME,CODE,IBLOCK_SECTION_ID,SORT', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Числовые значения и флаги Y/N приходят строками. Если в select есть распознанные имена полей, в объекте остаются только эти поля.

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив объектов разделов. Состав объекта — в методе Получить раздел. Если подходящих разделов нет, возвращается []
meta object Сведения о количестве разделов
meta.total number Общее количество разделов, соответствующих фильтру. Это единственное поле в meta

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

Ответ на запрос с select=ID,NAME,CODE,IBLOCK_SECTION_ID,SORT из примеров выше:

JSON 
{
  "success": true,
  "data": [
    {
      "ID": "263",
      "NAME": "Документы отдела продаж",
      "CODE": "sales_docs",
      "IBLOCK_SECTION_ID": null,
      "SORT": "100"
    },
    {
      "ID": "267",
      "NAME": "Документы отдела маркетинга",
      "CODE": "marketing_docs",
      "IBLOCK_SECTION_ID": null,
      "SORT": "300"
    },
    {
      "ID": "265",
      "NAME": "Счета",
      "CODE": "invoices",
      "IBLOCK_SECTION_ID": "263",
      "SORT": "200"
    }
  ],
  "meta": {
    "total": 3
  }
}

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

400 — параметр filter не является корректным JSON:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_FILTER",
    "message": "filter must be valid JSON, e.g. filter={\"NAME\":\"%urgent%\"}."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_FILTER filter не является JSON-объектом. Также отклоняются смешение JSON и скобочной формы, конфликтующие формы одного условия и скобочная вложенность глубже двух уровней
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в набор lists, bitrix_processes, lists_socnet, structure
403 BITRIX_ACCESS_DENIED Нет прав на список
422 BITRIX_ERROR Список не существует или его тип не соответствует параметрам запроса, например socnetGroupId передан для обычного списка. В ответе b24Code: "0"
409 LISTS_MODULE_NOT_ENABLED Модуль «Списки» не подключён на портале
403 SCOPE_DENIED У API-ключа нет скоупа lists
401 TOKEN_MISSING У API-ключа нет настроенных токенов

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

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

Дерево восстанавливается по IBLOCK_SECTION_ID. Разделы приходят плоским массивом. При использовании select включите в него ID и IBLOCK_SECTION_ID. Чтобы построить дерево, сгруппируйте разделы по значению IBLOCK_SECTION_ID: у корневых оно равно null, у вложенных — идентификатору родительского раздела.

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