[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fdoc-templates\u002Fsearch":3,"docs-tabs-entities\u002Fdoc-templates\u002Fsearch":6},{"content":4,"lastmod":5},"\n## Поиск шаблонов\n\n`POST \u002Fv1\u002Fdoc-templates\u002Fsearch`\n\nВозвращает шаблоны документов портала по фильтру, переданному в теле запроса. Для выборок до 5000 записей используйте `GET \u002Fv1\u002Fdoc-templates` с параметрами в строке запроса.\n\n## Поля запроса (body)\n\n| Поле | Тип | По умолч. | Описание |\n|------|-----|-----------|---------|\n| `filter` | object | — | Фильтрация по полям шаблона. Список полей — `GET \u002Fv1\u002Fdoc-templates\u002Ffields`.\u003Cbr>[Синтаксис фильтрации](\u002Fdocs\u002Ffiltering). Пример: `{\"filter\": {\"active\": \"Y\"}}` |\n| `select` | string[] | — | Выборка полей: `[\"id\", \"name\", \"region\"]` |\n| `sort` | object | — | Сортировка по полю: `{\"sort\": {\"id\": \"desc\"}}` |\n| `limit` | number | `50` | Количество записей (до 5000) |\n| `offset` | number | `0` | Смещение для пагинации |\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdoc-templates\u002Fsearch\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"filter\": { \"region\": \"ru\", \"active\": \"Y\" },\n    \"limit\": 10,\n    \"select\": [\"id\", \"name\", \"region\", \"active\"]\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdoc-templates\u002Fsearch\" \\\n  -H \"X-Api-Key: YOUR_APP_KEY\" \\\n  -H \"Authorization: Bearer USER_SESSION_TOKEN\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"filter\": { \"region\": \"ru\", \"active\": \"Y\" },\n    \"limit\": 10,\n    \"select\": [\"id\", \"name\", \"region\", \"active\"]\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdoc-templates\u002Fsearch', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_API_KEY',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    filter: { region: 'ru', active: 'Y' },\n    limit: 10,\n    select: ['id', 'name', 'region', 'active'],\n  }),\n})\n\nconst { success, data, meta } = await res.json()\nconsole.log(`Найдено ${meta.total} шаблонов`)\n```\n\n### JavaScript — OAuth-приложение\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdoc-templates\u002Fsearch', {\n  method: 'POST',\n  headers: {\n    'X-Api-Key': 'YOUR_APP_KEY',\n    'Authorization': 'Bearer USER_SESSION_TOKEN',\n    'Content-Type': 'application\u002Fjson',\n  },\n  body: JSON.stringify({\n    filter: { region: 'ru', active: 'Y' },\n    limit: 10,\n    select: ['id', 'name', 'region', 'active'],\n  }),\n})\n\nconst { success, data, meta } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data` | array | Массив шаблонов |\n| `data[].id` | number | Идентификатор шаблона |\n| `data[].name` | string | Название |\n| `data[].active` | string | Доступность: `Y` \u002F `N` |\n| `data[].code` | string \\| null | Системный код шаблона |\n| `data[].region` | string | Регион |\n| `data[].sort` | number | Порядок в списке |\n| `data[].createTime` | string | Дата создания (ISO 8601) |\n| `data[].updateTime` | string | Дата изменения (ISO 8601) |\n| `data[].createdBy` | number | Идентификатор создавшего сотрудника |\n| `data[].updatedBy` | number \\| null | Идентификатор изменившего сотрудника |\n| `data[].moduleId` | string | Модуль-источник шаблона |\n| `data[].fileId` | number | Идентификатор файла на Диске |\n| `data[].bodyType` | string | Формат тела документа |\n| `data[].numeratorId` | number | Идентификатор нумератора |\n| `data[].withStamps` | string | Печати и подписи: `Y` \u002F `N` |\n| `data[].productsTableVariant` | string | Вариант таблицы товаров в документе |\n| `data[].isDeleted` | boolean | Помечен ли шаблон удалённым |\n| `data[].isDefault` | string | Шаблон по умолчанию: `Y` \u002F `N` |\n| `data[].users` | array | Идентификаторы сотрудников, которым доступен шаблон |\n| `data[].download` | string | Адрес скачивания документа |\n| `data[].downloadMachine` | string | Адрес скачивания для программного доступа |\n| `meta.total` | number | Сколько записей подошло под фильтр |\n| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |\n| `meta.durationMs` | number | Длительность запроса в миллисекундах |\n\nПоля `meta` лежат рядом с `data`, а не внутри него. Обходить страницы нужно по `meta.hasMore`: длина `data`, равная `limit`, последней страницы не исключает.\n\nПолная схема полей шаблона — [Поля шаблона](.\u002Ffields.md).\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 209,\n      \"active\": \"Y\",\n      \"name\": \"Шаблон договора\",\n      \"code\": null,\n      \"region\": \"ru\",\n      \"sort\": 500,\n      \"createTime\": \"2026-05-12T09:03:38.000Z\",\n      \"updateTime\": \"2026-05-12T09:03:38.000Z\",\n      \"createdBy\": 1,\n      \"updatedBy\": null,\n      \"moduleId\": \"rest\",\n      \"fileId\": 9175,\n      \"bodyType\": \"Bitrix\\\\DocumentGenerator\\\\Body\\\\Docx\",\n      \"numeratorId\": 1,\n      \"withStamps\": \"N\",\n      \"productsTableVariant\": \"\",\n      \"isDeleted\": false,\n      \"isDefault\": \"N\",\n      \"users\": [\"U1\"],\n      \"download\": \"\u002Fbitrix\u002Fservices\u002Fmain\u002Fajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=209\",\n      \"downloadMachine\": \"https:\u002F\u002F\u003Cportal>\u002Frest\u002F1\u002F\u003Ctoken>\u002Fdocumentgenerator.api.template.download\u002F?token=\u003Ctoken>\"\n    },\n    {\n      \"id\": 211,\n      \"active\": \"Y\",\n      \"name\": \"Шаблон счёта\",\n      \"code\": null,\n      \"region\": \"ru\",\n      \"sort\": 500,\n      \"createTime\": \"2026-05-12T09:04:38.000Z\",\n      \"updateTime\": \"2026-05-12T09:04:38.000Z\",\n      \"createdBy\": 1,\n      \"updatedBy\": null,\n      \"moduleId\": \"rest\",\n      \"fileId\": 5901,\n      \"bodyType\": \"Bitrix\\\\DocumentGenerator\\\\Body\\\\Docx\",\n      \"numeratorId\": 1,\n      \"withStamps\": \"N\",\n      \"productsTableVariant\": \"\",\n      \"isDeleted\": false,\n      \"isDefault\": \"N\",\n      \"users\": [\"U1\"],\n      \"download\": \"\u002Fbitrix\u002Fservices\u002Fmain\u002Fajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=211\",\n      \"downloadMachine\": \"https:\u002F\u002F\u003Cportal>\u002Frest\u002F1\u002F\u003Ctoken>\u002Fdocumentgenerator.api.template.download\u002F?token=\u003Ctoken>\"\n    }\n  ],\n  \"meta\": {\n    \"total\": 2,\n    \"hasMore\": false,\n    \"durationMs\": 799\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n400 — фильтр по несуществующему полю. Сообщение перечисляет доступные для фильтрации поля:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"UNKNOWN_FILTER_FIELD\",\n    \"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\"\n  }\n}\n```\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `UNKNOWN_FILTER_FIELD` | Фильтр по несуществующему полю. Сообщение перечисляет доступные поля |\n| 400 | `UNKNOWN_SORT_FIELD` | Сортировка по несуществующему полю в `sort`. Сообщение перечисляет доступные поля |\n| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `documentgenerator` |\n| 401 | `TOKEN_MISSING` | У ключа нет настроенных токенов |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Известные особенности\n\n**Сортировка и постраничная выборка — на стороне Вайбкод.** `sort` (`{\"sort\": {\"поле\": \"asc|desc\"}}`) и `offset`\u002F`limit` применяются на стороне Вайбкод: набор вытягивается полностью, сортируется и режется по запрошенному окну. `total` и `hasMore` считаются от собранного набора.\n\n**Строковая сортировка — побайтовая.** Сортировка по строковым полям (`name`, `region`) сравнивает строки побайтово, без учёта локали и регистра. Числовые (`id`, `sort`) и датовременные (`createTime`, `updateTime`) поля сортируются корректно. Пустые значения (`null`\u002Fпустая строка) всегда идут в конце.\n\n## Смотрите также\n\n- [Список шаблонов](\u002Fdocs\u002Fentities\u002Fdoc-templates\u002Flist)\n- [Поля шаблона](\u002Fdocs\u002Fentities\u002Fdoc-templates\u002Ffields)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n","2026-07-27",{}]