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

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

GET /v1/doc-templates

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

Параметры

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

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

Примеры

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

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

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

Terminal
curl -g "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 Типnumber ОписаниеИдентификатор создавшего сотрудника
Полеdata[].updatedBy Типnumber | 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 ОписаниеАдрес Vibe API; нужен X-Api-Key со скоупом documentgenerator
Поле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://vibecode.bitrix24.tech/v1/doc-templates/209/download"
    },
    {
      "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://vibecode.bitrix24.tech/v1/doc-templates/211/download"
    }
  ],
  "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, createdBy, updatedBy, isDeleted, createTime, updateTime, download, downloadMachine, providers, isDefault, productsTableVariant"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеФильтр по несуществующему полю. Сообщение перечисляет доступные поля
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа documentgenerator
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After

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

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

Сортировка и постраничная выборка — на стороне Вайбкод. order, offset и limit применяются на стороне Вайбкод: набор вытягивается полностью, сортируется и режется по запрошенному окну. total и hasMore считаются от собранного набора.

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

Строковая сортировка — побайтовая. Сортировка по строковым полям (name, region) сравнивает строки побайтово, без учёта локали и регистра, поэтому порядок кириллицы и смешанного регистра может отличаться от привычного «человеческого». Числовые (id, sort) и датовременные (createTime, updateTime) поля сортируются корректно. Пустые значения (null/пустая строка) всегда идут в конце.

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