library.category.list

Scope: library

Кто может вызывать: Сотрудник.

Список категорий каталога.

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр	Тип	Обяз.	Описание
`limit`	`int`	нет	Размер страницы; по умолчанию 50, максимум 500
`offset`	`int`	нет	Смещение; по умолчанию 0
`fetchAll`	`bool`	нет	Вернуть все строки (защитный лимит `fetchAllMax` из library.schema)
`filter`	`object`	нет	Mongo-style фильтр (`$eq`, `$in`, …); допускается JSON-строка. Алиасы: `listFilter, mongoFilter`

Поля filter (Mongo)

Поле	Алиасы	Описание
`id`	`categoryId`, `sectionId`	ID категории
`name`	—	Название
`color`	—	Цвет
`active`	—	Активность
`booksCount`	—	Число книг
`createdBy`, `dateCreate`, `modifiedBy`, `dateModify`	—	Метаданные

Возвращаемые данные

Объект категории в result.result (list — массив + total, next):

Поле	Тип	Описание
`id`	`int`	ID раздела
`name`	`string`	Название
`active`	`bool`	Активна
`sort`	`int`	Сортировка
`color`	`string`	Цвет (CSS)
`booksCount`	`int`	Число книг в разделе
`createdBy`	`int`	Создатель
`dateCreate`	`string`	Дата создания
`modifiedBy`	`int`	Кто изменил
`dateModify`	`string`	Дата изменения

Обработка ошибок

Справочник кодов: error-codes.md.

Код	Описание
`UNAUTHORIZED`	Пользователь не авторизован
`ACCESS_DENIED`	Нет доступа к разделу «Библиотека»
`INVALID_LIMIT`	`limit` вне диапазона 1..500
`INVALID_OFFSET`	`offset` < 0
`INVALID_FILTER`	Некорректный `filter` или неизвестное поле (`details.allowed`)
`INVALID_FILTER_OPERATOR`	Неизвестный оператор фильтра
`FETCH_ALL_LIMIT_EXCEEDED`	При `fetchAll=true` записей больше защитного лимита
`INTERNAL_ERROR`	Внутренняя ошибка

Пример запроса (GET)

curl -G "https://76590.dev.wehive.digital/rest/1/{webhook_code}/library.category.list.json" --data-urlencode "limit=2"

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

{
          "result": {
            "result": [
              {
                "id": 135,
                "name": "REST cat 175340",
                "active": true,
                "sort": 100,
                "color": "",
                "booksCount": 0,
                "createdBy": 1,
                "dateCreate": "26.08.2026 17:53:41",
                "modifiedBy": 1,
                "dateModify": "27.08.2026 08:50:54"
              },
              {
                "id": 137,
                "name": "REST docs cat upd 20260827-102223",
                "active": true,
                "sort": 410,
                "color": "#993366",
                "booksCount": 0,
                "createdBy": 1,
                "dateCreate": "27.08.2026 10:22:25",
                "modifiedBy": 1,
                "dateModify": "27.08.2026 10:22:26"
              }
            ],
            "error": null
          },
          "next": 2,
          "total": 15
        }