Для AI-агентов: markdown этой страницы — /docs-content/note/collections/list.md индекс документации — /llms.txt

Список баз знаний

GET /v1/note/collections

Возвращает базы знаний, доступные текущему API-ключу на портале. Поддерживает курсорную пагинацию для обхода больших списков.

Параметры

Параметр Тип Обяз. Описание
limit (query) integer нет Размер страницы. По умолчанию 50, от 1 до 200
afterPosition (query) integer нет Значение position из meta.nextCursor предыдущего ответа. Передаётся вместе с afterId
afterId (query) integer нет Значение id из meta.nextCursor предыдущего ответа. Передаётся вместе с afterPosition

Пагинация. Курсорная. limit задаёт размер страницы. Для следующей страницы передайте afterPosition и afterId из meta.nextCursor предыдущего ответа. Когда meta.nextCursor равен null, страниц больше нет.

Примеры

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/note/collections \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/note/collections \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/collections', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Базы знаний:', data)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/collections', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив баз знаний
data[].id number Идентификатор базы знаний
data[].name string Название базы знаний
data[].position number Числовая позиция базы знаний
data[].policyLevel string Уровень политики доступа базы знаний, например none
data[].createdBy number Идентификатор сотрудника, создавшего базу знаний. Список: GET /v1/users
data[].createdAt string Дата создания в формате ISO 8601
data[].updatedBy number Идентификатор сотрудника, изменившего базу знаний последним. Список: GET /v1/users
data[].updatedAt string Дата последнего изменения в формате ISO 8601
meta.nextCursor object или null Курсор следующей страницы — объект с полями position и id. null, когда страниц больше нет

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Моя компания",
      "position": 1000,
      "policyLevel": "none",
      "createdBy": 0,
      "createdAt": "2026-05-21T17:36:10Z",
      "updatedBy": 0,
      "updatedAt": "2026-05-21T17:36:10Z"
    },
    {
      "id": 9,
      "name": "Документация продукта",
      "position": 100,
      "policyLevel": "none",
      "createdBy": 1269,
      "createdAt": "2026-06-23T19:01:03Z",
      "updatedBy": 1269,
      "updatedAt": "2026-06-23T19:05:39Z"
    },
    {
      "id": 7,
      "name": "Тест БЗ",
      "position": 100,
      "policyLevel": "none",
      "createdBy": 1269,
      "createdAt": "2026-06-22T09:16:33Z",
      "updatedBy": 1269,
      "updatedAt": "2026-06-22T09:16:33Z"
    }
  ],
  "meta": { "nextCursor": null }
}

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

400 — некорректный limit:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "`limit` must be an integer between 1 and 200"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS limit вне диапазона от 1 до 200, либо передан только один из afterPosition / afterId
403 SCOPE_DENIED Ключу не хватает скоупа note
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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