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

GET /v1/documents/:id

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

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор документа

#Примеры

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

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents/51', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Документ:', data.title, '—', data.number)

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

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

const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Объект документа со всеми полями — см. Поля документа

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

JSON 
{
  "success": true,
  "data": {
    "id": 51,
    "title": "Договор поставки 2026-001",
    "number": "2026-001",
    "templateId": 53,
    "provider": "Bitrix\\DocumentGenerator\\DataProvider\\Rest",
    "value": "ORDER-1024",
    "fileId": 241,
    "pdfId": 245,
    "imageId": 243,
    "createTime": "2026-03-18T17:27:48+03:00",
    "updateTime": "2026-03-18T17:27:48+03:00",
    "createdBy": 503,
    "updatedBy": null,
    "values": {
      "DocumentNumber": "2026-001",
      "ClientName": "ООО «Ромашка»"
    },
    "stampsEnabled": false,
    "publicUrl": "https://example.bitrix24.ru/~aBcDeF",
    "downloadUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getfile&id=51",
    "pdfUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getpdf&id=51",
    "imageUrl": "https://example.bitrix24.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.document.getimage&id=51",
    "downloadUrlMachine": "https://example.bitrix24.ru/rest/documentgenerator.api.document.getfile.json?token=t0k3n",
    "pdfUrlMachine": "https://example.bitrix24.ru/rest/documentgenerator.api.document.getpdf.json?token=t0k3n",
    "imageUrlMachine": "https://example.bitrix24.ru/rest/documentgenerator.api.document.getimage.json?token=t0k3n"
  }
}

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

404 — документ не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Документ не найден"
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Документ с таким id не найден
403 SCOPE_DENIED Ключу не хватает скоупа documentgenerator
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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