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

Получить шаблон

GET /v1/doc-templates/:id

Возвращает один шаблон документа по идентификатору.

Параметры

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

Примеры

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

Terminal
curl "https://vibecode.bitrix24.tech/v1/doc-templates/209" \
  -H "X-Api-Key: YOUR_API_KEY"

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

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

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

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

const { success, data } = await res.json()
console.log('Шаблон:', data.name)

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеОбъект шаблона
Полеdata.id Типnumber ОписаниеИдентификатор шаблона
Полеdata.name Типstring ОписаниеНазвание
Полеdata.region Типstring ОписаниеРегион
Полеdata.code Типstring | null ОписаниеСистемный код шаблона
Полеdata.active Типstring ОписаниеДоступность: Y / N
Полеdata.moduleId Типstring ОписаниеМодуль-источник шаблона
Полеdata.numeratorId Типnumber ОписаниеИдентификатор нумератора
Полеdata.withStamps Типstring ОписаниеПечати и подписи: Y / N
Полеdata.sort Типnumber ОписаниеПорядок в списке
Полеdata.users Типobject ОписаниеСопоставление идентификаторов сотрудников, которым доступен шаблон
Полеdata.providers Типobject ОписаниеПоставщики данных шаблона
Полеdata.isDeleted Типboolean ОписаниеПомечен ли шаблон удалённым
Полеdata.createTime Типstring ОписаниеДата создания (ISO 8601)
Полеdata.updateTime Типstring ОписаниеДата изменения (ISO 8601)
Полеdata.download Типstring ОписаниеАдрес скачивания документа
Полеdata.downloadMachine Типstring ОписаниеАдрес Vibe API; нужен X-Api-Key со скоупом documentgenerator

Полная схема полей шаблона — Поля шаблона.

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

JSON
{
  "success": true,
  "data": {
    "id": 209,
    "name": "Шаблон договора",
    "region": "ru",
    "code": null,
    "download": "/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=209",
    "active": "Y",
    "moduleId": "rest",
    "numeratorId": 1,
    "withStamps": "N",
    "providers": {
      "bitrix\\documentgenerator\\dataprovider\\rest": "bitrix\\documentgenerator\\dataprovider\\rest"
    },
    "users": {
      "U1": "U1"
    },
    "isDeleted": false,
    "sort": 500,
    "createTime": "2026-05-12T09:03:38.000Z",
    "updateTime": "2026-05-12T09:03:38.000Z",
    "downloadMachine": "https://vibecode.bitrix24.tech/v1/doc-templates/209/download"
  }
}

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

404 — шаблон не найден:

JSON
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Шаблон не найден"
  }
}

Ошибки

HTTP Код Описание
HTTP404 КодENTITY_NOT_FOUND ОписаниеШаблона с указанным id нет (сообщение «Шаблон не найден»)
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа documentgenerator
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов

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

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