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

GET /v1/lists/:iblockId/sections

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

Параметры

Параметр Тип Обяз. По умолч. Описание
iblockId (path) string да — Числовой IBLOCK_ID или символьный код списка. Идентификаторы доступны через GET /v1/lists
iblockTypeId (query) string нет lists Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы
filter (query) object нет — Фильтрация по полям раздела — ID, NAME, CODE, IBLOCK_SECTION_ID, SORT.
Синтаксис фильтрации. Пример: ?filter={"NAME":"Документы"}
select (query) string нет — Список возвращаемых полей через запятую. Пример: ?select=ID,NAME,CODE

Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/sections \
  -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', {
  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/121/sections', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

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

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив разделов
data[].ID string Идентификатор раздела
data[].NAME string Название раздела
data[].IBLOCK_SECTION_ID string Идентификатор родительского раздела. Приходит null у корневого раздела
data[].SORT string Индекс сортировки
data[].CODE string Символьный код раздела
meta.total number Общее количество разделов, соответствующих запросу

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

JSON 
{
  "success": true,
  "data": [
    {
      "ID": "137",
      "NAME": "Документы отдела продаж",
      "IBLOCK_SECTION_ID": null,
      "SORT": "100",
      "CODE": "sales_docs"
    },
    {
      "ID": "139",
      "NAME": "Документы отдела маркетинга",
      "IBLOCK_SECTION_ID": null,
      "SORT": "200",
      "CODE": "marketing_docs"
    }
  ],
  "meta": { "total": 2 }
}

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

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
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в допустимый набор
403 BITRIX_ACCESS_DENIED Нет прав на список либо списка с таким идентификатором не существует
409 LISTS_MODULE_NOT_ENABLED Модуль «Списки» не подключён на портале
403 SCOPE_DENIED У API-ключа нет скоупа lists
401 TOKEN_MISSING У API-ключа нет настроенных токенов

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

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

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

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