Получить список баз знаний note.collection.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
noteКто может выполнять метод: пользователь с доступом к модулю База знаний
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод note.collection.list возвращает список доступных пользователю баз знаний.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter |
Фильтр списка в формате REST 3.0: массив условий вида Синтаксис фильтра описан в обзоре REST 3.0. По умолчанию возвращаются только активные базы знаний |
|
pagination |
Объект постраничной навигации. Описание структуры объекта |
|
select |
Список полей базы знаний, которые нужно вернуть в ответе, например По умолчанию возвращаются все поля |
Параметр filter
|
Поле |
Описание |
|
state |
Состояние базы знаний. Поддерживаются операторы Возможные значения:
По умолчанию: Условие по |
Параметр pagination
|
Название |
Описание |
|
limit |
Размер страницы. Допустимые значения: от По умолчанию: Значение приводится к целому числу. Значения больше |
|
afterCursor |
Курсор следующей страницы. Передавайте значение По умолчанию: первая страница. Если курсор не содержит оба поля |
Параметр afterCursor
|
Название |
Описание |
|
position* |
Значение поля Обязателен, если задан |
|
id* |
Идентификатор последней базы знаний из предыдущей страницы. Обязателен, если задан |
Поля курсора приводятся к целым числам. Чтобы не начать обход заново и не пропустить записи, передавайте курсор из ответа без изменений. Для следующего запроса сохраняйте тот же pagination.limit; завершайте обход при result.nextCursor = null.
Примеры кода
Как использовать примеры в документации
Вызов нового api отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/note.collection.list
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
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"pagination":{"limit":50,"afterCursor":{"position":100,"id":42}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.collection.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CollectionListResult = {
items: Array<{
id: number
name: string
position: number
policyLevel: string
accessLevel: string
state: 'live' | 'archived' | 'trashed'
isArchived: boolean
markdownDescription: string | null
createdBy: number
updatedBy: number
createdAt: ISODate
updatedAt: ISODate
}>
nextCursor: {
position: number
id: number
} | null
}
try {
const response = await $b24.actions.v3.call.make<CollectionListResult>({
method: 'note.collection.list',
params: {
pagination: {
limit: 50,
afterCursor: {
position: 100,
id: 42,
},
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Collections:', result.items.length, result.nextCursor)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listCollections() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.collection.list',
params: {
pagination: {
limit: 50,
afterCursor: {
position: 100,
id: 42,
},
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Collections:', result.items.length, result.nextCursor)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listCollections)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
pagination = {
"limit": 50,
"afterCursor": {
"position": 100,
"id": 42,
},
}
try:
bitrix_response = client.note.collection.list(
pagination=pagination,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
try {
$response = $b24Service
->core
->call(
'note.collection.list',
[
'pagination' => [
'limit' => 50,
'afterCursor' => [
'position' => 100,
'id' => 42,
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error listing collections: ' . $e->getMessage();
}
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
BX24.callMethod(
'note.collection.list',
{
pagination: {
limit: 50,
afterCursor: {
position: 100,
id: 42
}
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
require_once('crest.php');
$result = CRest::call(
'note.collection.list',
[
'pagination' => [
'limit' => 50,
'afterCursor' => [
'position' => 100,
'id' => 42,
],
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.collection.list", b24.Params{
"pagination": b24.Params{
"limit": 50,
"afterCursor": b24.Params{
"position": 100,
"id": 42,
},
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("note.collection.list: %w", err)
}
var result struct {
Items []struct {
ID int `json:"id"`
Name string `json:"name"`
} `json:"items"`
NextCursor *struct {
Position int `json:"position"`
ID int `json:"id"`
} `json:"nextCursor"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range result.Items {
fmt.Println(item.ID, item.Name)
}
if result.NextCursor != nil {
fmt.Println("Следующий курсор:", result.NextCursor.Position, result.NextCursor.ID)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"nextCursor": null,
"items": [
{
"id": 9,
"name": "База знаний 1",
"position": 100,
"policyLevel": "private",
"accessLevel": "full",
"state": "live",
"isArchived": false,
"createdBy": 1,
"createdAt": "2026-06-23T22:01:03+03:00",
"updatedBy": 1,
"updatedAt": "2026-06-23T22:05:39+03:00",
"markdownDescription": null
},
{
"id": 7,
"name": "База знаний 2",
"position": 100,
"policyLevel": "private",
"accessLevel": "full",
"state": "live",
"isArchived": false,
"createdBy": 1,
"createdAt": "2026-06-22T12:16:33+03:00",
"updatedBy": 1,
"updatedAt": "2026-06-22T12:16:33+03:00",
"markdownDescription": null
}
]
},
"time": {
"start": 1791206039,
"finish": 1791206039.885758,
"duration": 0.8857579231262207,
"processing": 0,
"date_start": "2026-10-05T16:13:59+03:00",
"date_finish": "2026-10-05T16:13:59+03:00",
"operating_reset_at": 1791206639,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект со списком баз знаний и курсором |
|
result.items |
Массив объектов баз знаний, доступных пользователю |
|
result.items[].id |
Идентификатор базы знаний |
|
result.items[].name |
Название базы знаний |
|
result.items[].position |
Позиция базы знаний в списке |
|
result.items[].policyLevel |
Код политики доступа базы знаний, например |
|
result.items[].accessLevel |
Код уровня доступа текущего пользователя к базе знаний. В примере — |
|
result.items[].state |
Состояние базы знаний: |
|
result.items[].isArchived |
|
|
result.items[].createdBy |
Идентификатор автора базы знаний |
|
result.items[].updatedBy |
Идентификатор последнего редактора базы знаний |
|
result.items[].createdAt |
Дата и время создания в формате ISO 8601 с часовым поясом |
|
result.items[].updatedAt |
Дата и время последнего изменения в формате ISO 8601 с часовым поясом |
|
result.items[].markdownDescription |
Дополнительное описание Markdown. В приведенном ответе — |
|
result.nextCursor |
Курсор следующей страницы. |
|
result.nextCursor.position |
Позиция последней базы знаний на странице. Присутствует, если |
|
result.nextCursor.id |
Идентификатор последней базы знаний на странице. Присутствует, если |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 403
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION",
"message": "Доступ запрещен"
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Выход pagination.limit за диапазон и неполный pagination.afterCursor не вызывают ошибки валидации: значения нормализуются по правилам из раздела «Параметры метода».
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
unknown state: expected one of live, archived, trashed |
Передайте |
|
|
operator "#OPERATOR#" is not supported for state: use "=" or "in" |
Используйте для |
|
|
state belongs to the top-level "and" of the filter: it cannot sit under "or" or under a negation |
Перенесите условие по |
|
|
В DTO |
Фильтруйте только по полю |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Укажите в |
Ошибки доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
У пользователя нет доступа к модулю База знаний |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Приложение Маркетплейса заблокировано, потому что число установленных приложений превышает лимит тарифа. События такому приложению не доставляются. Приложения, освобожденные от лимита, не блокируются |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |