[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-entities\u002Fdocuments\u002Fsearch":3,"docs-tabs-entities\u002Fdocuments\u002Fsearch":6},{"content":4,"lastmod":5},"\n## Поиск документов\n\n`POST \u002Fv1\u002Fdocuments\u002Fsearch`\n\nВозвращает документы по фильтру, переданному в теле запроса. Аналогичен `GET \u002Fv1\u002Fdocuments` с фильтрами, но условия отбора передаются в теле запроса — это удобнее для сложных выборок с большим количеством условий.\n\n## Поля запроса (body)\n\n| Поле | Тип | По умолч. | Описание |\n|------|-----|-----------|---------|\n| `filter` | object | — | Отбор по полям документа.\u003Cbr>[Синтаксис фильтрации](\u002Fdocs\u002Ffiltering). Пример: `{ \"filter\": { \"templateId\": 53 } }` |\n| `limit` | number | `50` | Количество документов в ответе, до 5000 |\n| `offset` | number | `0` | Пропустить указанное число документов. Вместе с фильтром по диапазону дат шире 14 дней отклоняется — см. `UNSTABLE_OFFSET_PAGINATION` в разделе «Ошибки» |\n| `sort` | object | — | Сортировка: `{ \"id\": \"desc\" }`. Допустимы те же поля, что и в `filter` |\n| `select` | string[] | — | Выборка полей: `[\"id\", \"title\", \"number\"]`. В ответе остаются только перечисленные поля и `id` |\n| `autoWindow` | boolean | `true` | Разбивать выборку по недельным окнам при фильтре по диапазону дат шире 14 дней. `false` отключает разбиение |\n\nИмена полей для `filter`, `sort` и `select` — из [Полей документа](\u002Fdocs\u002Fentities\u002Fdocuments\u002Ffields).\n\n## Примеры\n\n### curl — личный ключ\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdocuments\u002Fsearch\" \\\n  -H \"X-Api-Key: YOUR_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"filter\": { \"templateId\": 53 },\n    \"limit\": 10,\n    \"sort\": { \"id\": \"desc\" }\n  }'\n```\n\n### curl — OAuth-приложение\n\n```bash\ncurl -X POST \"https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdocuments\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\": { \"templateId\": 53 },\n    \"limit\": 10,\n    \"sort\": { \"id\": \"desc\" }\n  }'\n```\n\n### JavaScript — личный ключ\n\n```javascript\nconst res = await fetch('https:\u002F\u002Fvibecode.bitrix24.tech\u002Fv1\u002Fdocuments\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: { templateId: 53 },\n    limit: 10,\n    sort: { id: 'desc' },\n  }),\n})\n\nconst { 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\u002Fdocuments\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: { templateId: 53 },\n    limit: 10,\n    sort: { id: 'desc' },\n  }),\n})\n\nconst { data, meta } = await res.json()\n```\n\n## Поля ответа\n\n| Поле | Тип | Описание |\n|------|-----|---------|\n| `success` | boolean | Всегда `true` при успехе |\n| `data` | array | Массив документов (все поля — см. [Поля документа](\u002Fdocs\u002Fentities\u002Fdocuments\u002Ffields)) |\n| `meta.total` | number | Сколько записей подошло под фильтр |\n| `meta.hasMore` | boolean | Есть ли ещё записи за пределами `limit` |\n| `meta.durationMs` | number | Длительность запроса в миллисекундах |\n| `meta.autoWindowed` | boolean | `true`, если выборка была разбита по временны́м окнам |\n| `meta.windowCount` | number | Число окон. Приходит при `autoWindowed: true` |\n| `meta.batchWaves` | number | Число волн параллельных запросов. Приходит при `autoWindowed: true` |\n\n## Пример ответа\n\n```json\n{\n  \"success\": true,\n  \"data\": [\n    {\n      \"id\": 51,\n      \"title\": \"Договор поставки 2026-001\",\n      \"number\": \"2026-001\",\n      \"templateId\": 53,\n      \"provider\": \"Bitrix\\\\DocumentGenerator\\\\DataProvider\\\\Rest\",\n      \"value\": \"ORDER-1024\",\n      \"createTime\": \"2026-03-18T17:27:48+03:00\",\n      \"updateTime\": \"2026-03-18T17:27:48+03:00\",\n      \"createdBy\": 503,\n      \"updatedBy\": null,\n      \"values\": { \"DocumentNumber\": \"2026-001\" },\n      \"stampsEnabled\": false,\n      \"pdfUrl\": \"https:\u002F\u002Fexample.bitrix24.ru\u002Fbitrix\u002Fservices\u002Fmain\u002Fajax.php?action=documentgenerator.api.document.getpdf&id=51\"\n    }\n  ],\n  \"meta\": { \"total\": 1, \"hasMore\": false, \"durationMs\": 42 }\n}\n```\n\nКогда под фильтр не попал ни один документ, `data` приходит пустым массивом, а `meta.total` равен `0`:\n\n```json\n{\n  \"success\": true,\n  \"data\": [],\n  \"meta\": { \"total\": 0, \"hasMore\": false, \"durationMs\": 644 }\n}\n```\n\nС фильтром по диапазону дат шире 14 дней в `meta` дополнительно приходят `autoWindowed`, `windowCount` и `batchWaves`:\n\n```json\n{\n  \"success\": true,\n  \"data\": [],\n  \"meta\": {\n    \"total\": 0,\n    \"hasMore\": false,\n    \"autoWindowed\": true,\n    \"windowCount\": 339,\n    \"batchWaves\": 7,\n    \"durationMs\": 7890\n  }\n}\n```\n\n## Пример ответа при ошибке\n\n400 — поле в `filter` не входит в список полей документа:\n\n```json\n{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"UNKNOWN_FILTER_FIELD\",\n    \"message\": \"Unknown filter field 'notArealField' for entity 'documents'.\"\n  }\n}\n```\n\n## Известные особенности\n\nИмя поля в `filter` и `sort` сверяется со списком полей документа до обращения к данным. Неизвестное поле в `filter` возвращает `400 UNKNOWN_FILTER_FIELD`, неизвестное поле в `sort` — `400 UNKNOWN_SORT_FIELD`. В обоих случаях сообщение перечисляет допустимые имена полей.\n\n**Разбиение по временны́м окнам.** Фильтр по диапазону дат шире 14 дней (поля `createTime` или `updateTime`) автоматически разбивается на недельные окна, которые выполняются параллельными волнами — так выборка обходит потолок в 5000 документов на один вызов. В `meta` тогда приходят `autoWindowed: true`, число окон `windowCount` и число волн `batchWaves`. Отключает разбиение параметр `autoWindow: false`. При активном разбиении `offset` больше нуля отклоняется с `UNSTABLE_OFFSET_PAGINATION`.\n\n## Ошибки\n\n| HTTP | Код | Описание |\n|------|-----|---------|\n| 400 | `UNKNOWN_FILTER_FIELD` | Поле в `filter` не входит в список полей документа |\n| 400 | `UNKNOWN_SORT_FIELD` | Поле в `sort` не входит в список полей документа |\n| 400 | `UNSTABLE_OFFSET_PAGINATION` | `offset` больше нуля вместе с фильтром по диапазону дат шире 14 дней. Два разных алгоритма выдачи дают несогласованные результаты, поэтому запрос отклоняется. Возьмите всё одним запросом с `limit` до 5000, либо передайте `autoWindow: false` с сортировкой по `id`, либо режьте диапазон дат на части сами |\n| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `documentgenerator` |\n| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |\n\nПолный список общих ошибок API — [Ошибки](\u002Fdocs\u002Ferrors).\n\n## Смотрите также\n\n- [Список документов](\u002Fdocs\u002Fentities\u002Fdocuments\u002Flist)\n- [Синтаксис фильтрации](\u002Fdocs\u002Ffiltering)\n- [Справочник сущностей](\u002Fdocs\u002Fentity-api)\n- [Batch-запросы](\u002Fdocs\u002Fbatch)\n","2026-07-27",{}]