Full-text Disk search

POST /v1/files/fulltext-search

Searches the index across accessible Disk. Single-folder search accepts filters, while this route accepts a search string. Requires disk scope. READONLY keys are allowed.

Request fields

Field	Type	Required	Description
`query`	string	yes	Required. Whitespace is collapsed and trimmed, then length must be 3..255 characters
`type`	string	no	`file`, `folder`, `all`. Default `file`
`filter.storageId`	number	no	Positive integer ID from storage listing
`filter.folderId`	number	no	Positive integer ID from folder listing
`filter.fileType`	string or array	no	Only with `type=file`: `document`, `image`, `video`, `audio`, `archive`, `pdf`, `vector_image`, `board`, `known`, `unknown`. Arrays must be nonempty
`offset`	number	no	Integer 0..1000, default 0

Unknown fields are refused. limit is not accepted: the native Bitrix24 page size is fixed at 50 records.

Examples

curl — personal key

Terminal

curl -X POST 'https://vibecode.bitrix24.com/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 application

Terminal

curl -X POST 'https://vibecode.bitrix24.com/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 — personal key

javascript

const response = await fetch('https://vibecode.bitrix24.com/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 application

javascript

const response = await fetch('https://vibecode.bitrix24.com/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)

Response fields

Field	Type	Description
`success`	boolean	Successful request
`data.items`	array	Files or folders
`data.meta.nextOffset`	number \| null	Next offset; null at the end
`data.meta.maxOffset`	number	Maximum offset: 1000

JSON

{"success":true,"data":{"items":[{"id":42,"type":"file","name":"report.pdf","folderId":9,"downloadUrl":"https://vibecode.bitrix24.com/v1/files/42/download"}],"meta":{"nextOffset":null,"maxOffset":1000}}}

data.items contains files in the files projection and folders in the folders projection. Follow downloadUrl with the same API key. data.meta.nextOffset is the next page offset or null; use it in the next request. There is no total: Bitrix24 does not return the match count.

Trash is excluded. Empty results do not prove absence: indexing is asynchronous and content indexing depends on format. Name search is more reliable. You cannot continue past offset 1000; narrow the query.

Errors

Example refusal (400):