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

Получить документ

GET /v1/note/documents/:id

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

Параметры

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

Примеры

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

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.id Типnumber ОписаниеИдентификатор документа
Полеdata.collectionId Типnumber ОписаниеБаза знаний, которой принадлежит документ. Список: GET /v1/note/collections
Полеdata.parentId Типnumber или null ОписаниеРодительский документ в дереве базы знаний. null у документа верхнего уровня
Полеdata.title Типstring ОписаниеЗаголовок документа
Полеdata.markdown Типstring ОписаниеСодержимое документа в разметке Markdown
Полеdata.position Типnumber ОписаниеПорядок сортировки среди соседних документов
Полеdata.createdBy Типnumber ОписаниеИдентификатор создателя. Список: GET /v1/users
Полеdata.updatedBy Типnumber ОписаниеИдентификатор автора последнего изменения. Список: GET /v1/users
Полеdata.createdAt Типstring ОписаниеДата создания в формате ISO 8601
Полеdata.updatedAt Типstring ОписаниеДата последнего изменения в формате ISO 8601. Меняется при любой правке, включая заголовок и архивацию
Полеdata.contentUpdatedAt Типstring ОписаниеДата последнего изменения содержимого markdown в формате ISO 8601. Правка одного заголовка её не меняет
Полеdata.isArchived Типboolean Описаниеtrue у архивированного документа
Полеdata.isTrashed Типboolean Описаниеtrue у документа в корзине
Полеdata.isOrphan Типboolean Описаниеtrue у документа, не принадлежащего ни одной базе знаний. На проверенных документах — false

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

JSON 
{
  "success": true,
  "data": {
    "id": 65,
    "collectionId": 27,
    "parentId": null,
    "title": "Глава 1",
    "markdown": "# Глава 1\n\nТекст документа",
    "position": 1000,
    "createdBy": 1295,
    "updatedBy": 1295,
    "createdAt": "2026-09-15T12:44:34Z",
    "updatedAt": "2026-09-15T12:44:34Z",
    "contentUpdatedAt": "2026-09-15T12:44:34Z",
    "isArchived": false,
    "isTrashed": false,
    "isOrphan": false
  }
}

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

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-ключа не настроены токены

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

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

Вставки прикреплённых файлов в тексте. Поле markdown может содержать блоки вида [[image fileId=17]], где тип — image, video или file. Так в текст документа встраиваются загруженные к нему файлы. При отображении документа обрабатывайте эти блоки отдельно от остальной разметки Markdown.

Архивный документ и документ в корзине возвращаются. После архивации и после удаления запрос по-прежнему отвечает 200 — состояние видно по isArchived и isTrashed. Ошибку 404 даёт только несуществующий идентификатор. Изменить такой документ нельзя: PATCH на него отвечает 404.

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