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

Поиск шаблонов

POST /v1/doc-templates/search

Возвращает шаблоны документов портала по фильтру, переданному в теле запроса. Для выборок до 5000 записей используйте GET /v1/doc-templates с параметрами в строке запроса.

Поля запроса (body)

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

Примеры

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/doc-templates/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "region": "ru", "active": "Y" },
    "limit": 10,
    "select": ["id", "name", "region", "active"]
  }'

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

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/doc-templates/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "region": "ru", "active": "Y" },
    "limit": 10,
    "select": ["id", "name", "region", "active"]
  }'

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

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/doc-templates/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { region: 'ru', active: 'Y' },
    limit: 10,
    select: ['id', 'name', 'region', 'active'],
  }),
})

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/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { region: 'ru', active: 'Y' },
    limit: 10,
    select: ['id', 'name', 'region', 'active'],
  }),
})

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
Полеmeta.durationMs Типnumber ОписаниеДлительность запроса в миллисекундах

Поля meta лежат рядом с data, а не внутри него. Обходить страницы нужно по meta.hasMore: длина data, равная 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,
    "durationMs": 799
  }
}

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

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

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

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

Сортировка и постраничная выборка — на стороне Вайбкод. sort ({"sort": {"поле": "asc|desc"}}) и offset/limit применяются на стороне Вайбкод: набор вытягивается полностью, сортируется и режется по запрошенному окну. total и hasMore считаются от собранного набора.

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

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