Список разделов

GET /v1/catalog-sections

Возвращает список разделов каталога с поддержкой фильтрации, сортировки, выборки полей и пагинации. Требует фильтр filter[iblockId] — каталог, по разделам которого идёт выборка. Без этого фильтра запрос возвращает 400.

Параметры

Параметр Тип Обяз. По умолч. Описание
filter object да — Условия фильтрации. Ключ filter[iblockId] обязателен — ID каталога из `GET /v1/catalogs`.
Синтаксис фильтрации. Пример: ?filter[iblockId]=25
select string нет — Выборка полей: ?select=id,name,sort. Возвращаются только перечисленные поля
sort string нет — Поле сортировки. Префикс - — по убыванию: ?sort=-sort
limit number нет 50 Количество записей (до 5000)
offset number нет 0 Смещение от начала выборки

Для выборки разделов одного родителя добавьте filter[iblockSectionId].

Для limit > 50 ответ автоматически собирается из нескольких страниц на стороне сервера. Максимум — 5000 записей за вызов. Если под фильтр попадает больше записей, чем возвращено, в meta.hasMore придёт true.

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-sections?filter[iblockId]=25" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/catalog-sections?filter[iblockId]=25" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const url = 'https://vibecode.bitrix24.tech/v1/catalog-sections?filter[iblockId]=25'
const res = await fetch(url, {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Разделов: ${meta.total}`)

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

javascript 
const url = 'https://vibecode.bitrix24.tech/v1/catalog-sections?filter[iblockId]=25'
const res = await fetch(url, {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив разделов
data[].id number Идентификатор раздела
data[].iblockId number ID каталога, которому принадлежит раздел
data[].iblockSectionId number | null ID родительского раздела. null — раздел верхнего уровня
data[].name string Название раздела
data[].code string | null Символьный код раздела
data[].xmlId string | null Внешний идентификатор
data[].sort number Индекс сортировки
data[].active boolean Активен ли раздел
data[].description string | null Описание раздела
data[].descriptionType string Формат описания: text или html
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

JSON 
{
  "success": true,
  "data": [
    {
      "active": true,
      "code": "clothes",
      "description": null,
      "descriptionType": "text",
      "iblockId": 25,
      "iblockSectionId": null,
      "id": 31,
      "name": "Одежда",
      "sort": 50,
      "xmlId": null
    },
    {
      "active": true,
      "code": "shoes",
      "description": null,
      "descriptionType": "text",
      "iblockId": 25,
      "iblockSectionId": 31,
      "id": 35,
      "name": "Обувь",
      "sort": 100,
      "xmlId": null
    }
  ],
  "meta": {
    "total": 37,
    "hasMore": false
  }
}

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

400 — фильтр по несуществующему полю:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'bogus' for entity 'catalog-sections'. Available: id, iblockId, iblockSectionId, name, xmlId, code, sort, active, description, descriptionType"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_FILTER Не передан обязательный фильтр filter[iblockId]. Запрос отклоняется до обращения к Битрикс24 — сообщение содержит имя недостающего поля и пример вызова
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет у раздела. Сообщение содержит список доступных полей
400 UNKNOWN_SORT_FIELD Сортировка по полю, которого нет у раздела
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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