метод REST scope: note

note.collection.list

Получить список баз знаний

Кто может выполнять: пользователь с доступом к модулю База знаний

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.collection.list возвращает список доступных пользователю баз знаний.

Параметры

pagination object необязательный

Объект постраничной навигации. Описание структуры объекта

Параметр pagination

limit integer необязательный

Размер страницы.

Допустимые значения: от 1 до 200

По умолчанию: 50

afterCursor object необязательный

Курсор следующей страницы. Передавайте значение nextCursor из предыдущего ответа. Описание структуры объекта

Параметр afterCursor

position integer обязательный

Значение поля position последней базы знаний из предыдущей страницы.

Обязателен, если задан afterCursor

id integer обязательный

Идентификатор последней базы знаний из предыдущей страницы.

Обязателен, если задан afterCursor

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"pagination":{"limit":50,"afterCursor":{"position":100,"id":42}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.collection.list

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 1,
                "name": "Продуктовая документация",
                "position": 100,
                "policyLevel": "view",
                "createdBy": 1,
                "updatedBy": 1,
                "createdAt": "2026-04-20T12:00:00Z",
                "updatedAt": "2026-04-21T09:15:30Z"
            }
        ],
        "nextCursor": {
            "position": 100,
            "id": 1
        }
    },
    "time": {
        "start": 1780639200,
        "finish": 1780639200.224321,
        "duration": 0.2243211269378662,
        "processing": 0.18721413612365723,
        "date_start": "2026-06-19T10:00:00+03:00",
        "date_finish": "2026-06-19T10:00:00+03:00",
        "operating_reset_at": 1780639800,
        "operating": 0
    }
}

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

result object

Объект со списком баз знаний

items array

Список баз знаний, доступных пользователю

items[] object

Объект базы знаний

id integer

Идентификатор базы знаний

name string

Название базы знаний

position integer

Позиция базы знаний в общем списке

policyLevel string

Базовая политика доступа базы знаний.

Возможные значения:

  • none — нет доступа
  • view — просмотр
  • manage — редактирование
  • moderate — администрирование
createdBy integer

Идентификатор автора базы знаний

updatedBy integer

Идентификатор последнего редактора базы знаний

createdAt datetime

Дата и время создания базы знаний в UTC

updatedAt datetime

Дата и время последнего изменения базы знаний в UTC

nextCursor object

Курсор следующей страницы или null, если страниц больше нет

time time

Информация о времени выполнения запроса

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

HTTP-статус: 403

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION",
        "message": "Доступ запрещен"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
Доступ запрещен У пользователя нет доступа к модулю База знаний

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.