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

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

GET /v1/note/collections/:id

Возвращает одну базу знаний по её идентификатору. Используйте, когда известен идентификатор базы знаний и нужны её данные.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор базы знаний. Список: GET /v1/note/collections

Примеры

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

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

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/note/collections/9 \
  -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/9', {
  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/9', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
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

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

JSON 
{
  "success": true,
  "data": {
    "id": 9,
    "name": "Документация продукта",
    "position": 100,
    "policyLevel": "none",
    "createdBy": 1269,
    "createdAt": "2026-06-23T19:01:03Z",
    "updatedBy": 1269,
    "updatedAt": "2026-06-23T19:05:39Z"
  }
}

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

404 — база знаний не найдена:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `999999` не найдена"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не является положительным целым числом
404 ENTITY_NOT_FOUND База знаний с указанным id не найдена
403 SCOPE_DENIED Ключу не хватает скоупа note
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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