Для AI-агентов: markdown этой страницы — /docs-content/entities/files/fulltext-search.md индекс документации — /llms.txt
Полнотекстовый поиск на Диске
POST /v1/files/fulltext-search
Ищет по индексу во всём доступном Диске. Поиск в одной папке передаёт фильтры, а этот маршрут принимает поисковую строку. Скоуп disk. READONLY-ключ разрешён.
Поля запроса
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
Полеquery |
Типstring | Обяз.да | ОписаниеОбязательное. Пробелы схлопываются, края обрезаются, затем длина 3..255 символов |
Полеtype |
Типstring | Обяз.нет | Описаниеfile, folder, all. По умолчанию file |
Полеfilter.storageId |
Типnumber | Обяз.нет | ОписаниеЦелое положительное ID из списка хранилищ |
Полеfilter.folderId |
Типnumber | Обяз.нет | ОписаниеЦелое положительное ID из списка папок |
Полеfilter.fileType |
Типstring или array | Обяз.нет | ОписаниеТолько при type=file: document, image, video, audio, archive, pdf, vector_image, board, known, unknown. Массив непустой |
Полеoffset |
Типnumber | Обяз.нет | ОписаниеЦелое 0..1000, по умолчанию 0 |
Лишние поля отклоняются. limit не принимается: размер страницы Битрикс24 фиксирован, 50 записей.
Примеры
curl — личный ключ
curl -X POST 'https://vibecode.bitrix24.tech/v1/files/fulltext-search' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"query":"report","filter":{"fileType":"document"},"offset":0}'
curl — OAuth-приложение
curl -X POST 'https://vibecode.bitrix24.tech/v1/files/fulltext-search' \
-H 'X-Api-Key: YOUR_APP_KEY' \
-H 'Authorization: Bearer USER_SESSION_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"query":"report","filter":{"fileType":"document"},"offset":0}'
JavaScript — личный ключ
const response = await fetch('https://vibecode.bitrix24.tech/v1/files/fulltext-search', {
method: 'POST',
headers: {"X-Api-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
body: JSON.stringify({"query": "report", "filter": {"fileType": "document"}, "offset": 0}),
})
const result = await response.json()
console.log(result)
JavaScript — OAuth-приложение
const response = await fetch('https://vibecode.bitrix24.tech/v1/files/fulltext-search', {
method: 'POST',
headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN", "Content-Type": "application/json"},
body: JSON.stringify({"query": "report", "filter": {"fileType": "document"}, "offset": 0}),
})
const result = await response.json()
console.log(result)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеПризнак успешного запроса |
Полеdata |
Типobject | ОписаниеРезультат поиска: массив items и параметры постраничной навигации meta |
Полеdata.items |
Типarray | ОписаниеФайлы и папки — поля как в Получить файл и Получить папку |
Полеdata.meta.nextOffset |
Типnumber | null | ОписаниеСледующее смещение. null в конце выдачи |
Полеdata.meta.maxOffset |
Типnumber | ОписаниеМаксимальное смещение: 1000 |
data.items — файлы в проекции files, папки в проекции folders. Ссылку downloadUrl вызывайте с тем же API-ключом. data.meta.nextOffset — смещение следующей страницы или null, используйте его в следующем запросе. total отсутствует: Битрикс24 не возвращает число совпадений.
Корзина не ищется. Пустая выдача не доказывает отсутствие файла: индекс обновляется асинхронно, содержимое индексируется не у всех форматов. Поиск по имени надёжнее. После смещения 1000 продолжить нельзя, сужайте запрос.
Пример ответа
{
"success": true,
"data": {
"items": [
{
"id": 10639,
"name": "report.txt",
"code": null,
"storageId": 1,
"type": "file",
"folderId": 27,
"deletedType": 0,
"globalContentVersion": 1,
"fileId": 39127,
"size": 11,
"createdAt": "2026-10-13T11:15:36.000Z",
"updatedAt": "2026-10-13T11:15:36.000Z",
"deletedAt": null,
"createdBy": 1,
"updatedBy": 1,
"deletedBy": null,
"downloadUrl": "https://vibecode.bitrix24.tech/v1/files/10639/download",
"detailUrl": "https://example.bitrix24.ru/company/personal/user/1/disk/file/report.txt"
}
],
"meta": {
"nextOffset": null,
"maxOffset": 1000
}
}
}
Пример ответа при ошибке
400 — в query меньше трёх символов:
{
"success": false,
"error": {
"code": "INVALID_PARAMS",
"message": "query must contain 3..255 characters after whitespace normalization."
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеНеверные query, type, filter или offset, лишние поля |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеНет скоупа disk |
| HTTP403 | КодBITRIX_ACCESS_DENIED |
ОписаниеБитрикс24 отказал в доступе |
| HTTP404 | КодENTITY_NOT_FOUND |
ОписаниеХранилище или папка не найдены либо недоступны. Эти причины намеренно не различаются |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеБизнес-отказ Битрикс24 или ответ без результата |
| HTTP422 | КодOPERATION_FAILED |
ОписаниеБизнес-отказ Битрикс24 или ответ без результата |
Общие отказы — Ошибки.