#Список шаблонов

GET /v1/doc-templates

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

#Параметры

Параметр Тип По умолч. Описание
filter object — Фильтрация по полям шаблона. Список полей — GET /v1/doc-templates/fields.
Синтаксис фильтрации. Пример: ?filter[active]=Y
select string — Выборка полей: ?select=id,name,region
order object — Сортировка по полю: ?order[sort]=asc
limit number 50 Количество записей (до 5000)
offset number 0 Смещение для пагинации

Для limit > 50 Вайбкод автоматически запрашивает несколько страниц у Битрикс24 на стороне сервера. Максимум — 5000 записей за вызов.

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/doc-templates?limit=10&filter[active]=Y" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/doc-templates?limit=10&filter[active]=Y" \
  -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?limit=10&filter[active]=Y', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} шаблонов`)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/doc-templates?limit=10&filter[active]=Y', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив шаблонов
data[].id number Идентификатор шаблона
data[].name string Название
data[].active string Доступность: Y / N
data[].code string | null Системный код шаблона
data[].region string Регион
data[].sort number Порядок в списке
data[].createTime string Дата создания (ISO 8601)
data[].updateTime string Дата изменения (ISO 8601)
data[].createdBy string Идентификатор создавшего сотрудника
data[].updatedBy string | null Идентификатор изменившего сотрудника
data[].moduleId string Модуль-источник шаблона
data[].fileId number Идентификатор файла на Диске
data[].bodyType string Формат тела документа
data[].numeratorId number Идентификатор нумератора
data[].withStamps string Печати и подписи: Y / N
data[].productsTableVariant string Вариант таблицы товаров в документе
data[].isDeleted boolean Помечен ли шаблон удалённым
data[].isDefault string Шаблон по умолчанию: Y / N
data[].users array Идентификаторы сотрудников, которым доступен шаблон
data[].download string Адрес скачивания документа
data[].downloadMachine string Адрес скачивания для программного доступа
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 209,
      "active": "Y",
      "name": "Шаблон договора",
      "code": null,
      "region": "ru",
      "sort": 500,
      "createTime": "2026-05-12T09:03:38.000Z",
      "updateTime": "2026-05-12T09:03:38.000Z",
      "createdBy": "1",
      "updatedBy": null,
      "moduleId": "rest",
      "fileId": 9175,
      "bodyType": "Bitrix\\DocumentGenerator\\Body\\Docx",
      "numeratorId": 1,
      "withStamps": "N",
      "productsTableVariant": "",
      "isDeleted": false,
      "isDefault": "N",
      "users": ["U1"],
      "download": "/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=209",
      "downloadMachine": "https://<portal>/rest/1/<token>/documentgenerator.api.template.download/?token=<token>"
    },
    {
      "id": 211,
      "active": "Y",
      "name": "Шаблон счёта",
      "code": null,
      "region": "ru",
      "sort": 500,
      "createTime": "2026-05-12T09:04:38.000Z",
      "updateTime": "2026-05-12T09:04:38.000Z",
      "createdBy": "1",
      "updatedBy": null,
      "moduleId": "rest",
      "fileId": 5901,
      "bodyType": "Bitrix\\DocumentGenerator\\Body\\Docx",
      "numeratorId": 1,
      "withStamps": "N",
      "productsTableVariant": "",
      "isDeleted": false,
      "isDefault": "N",
      "users": ["U1"],
      "download": "/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=211",
      "downloadMachine": "https://<portal>/rest/1/<token>/documentgenerator.api.template.download/?token=<token>"
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

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

400 — фильтр по несуществующему полю. Сообщение перечисляет доступные для фильтрации поля:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'bogusField' for entity 'doc-templates'. Available: id, name, numeratorId, region, code, moduleId, active, bodyType, withStamps, sort, users, fileId, file, isDeleted, createTime, updateTime, provider, download, downloadMachine, providers"
  }
}

#Ошибки

HTTP Код Описание
400 UNKNOWN_FILTER_FIELD Фильтр по несуществующему полю; сообщение перечисляет доступные поля
403 SCOPE_DENIED Ключу не хватает скоупа documentgenerator
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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

Сортировка по несуществующему полю. Параметр order по полю, которого нет, не вызывает ошибку — запрос отрабатывает со статусом 200, а неизвестное поле сортировки пропускается.

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