Для 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 ОписаниеПолитика доступа базы знаний. На проверенном портале — portal у общей базы компании и private у остальных
Полеdata.accessLevel Типstring ОписаниеУровень доступа к базе знаний. На проверенных базах — full
Полеdata.isArchived Типboolean Описаниеtrue у архивированной базы знаний
Полеdata.createdBy Типnumber ОписаниеИдентификатор сотрудника, создавшего базу знаний. Список: GET /v1/users
Полеdata.createdAt Типstring ОписаниеДата создания в формате ISO 8601
Полеdata.updatedBy Типnumber ОписаниеИдентификатор сотрудника, изменившего базу знаний последним. Список: GET /v1/users
Полеdata.updatedAt Типstring ОписаниеДата последнего изменения в формате ISO 8601
Полеdata.markdownDescription Типstring или null ОписаниеОписание базы знаний в Markdown. На проверенных базах — null

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

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

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

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

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

Ошибки

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

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

Известные особенности

Архивированная база знаний возвращается. После архивации запрос отвечает 200 с isArchived: true — в отличие от списка, где такой базы знаний уже нет. Удалённая база знаний отвечает 404.

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