Skip to main content

A list of files, folders and web links that matched the search query.

type
enum<string>
required

Specifies the response as search result items without shared links.

Available options:
search_results_items
Example:

"search_results_items"

total_count
integer<int64>

One greater than the offset of the last entry in the search results. The total number of entries in the collection may be less than total_count.

Example:

5000

limit
integer<int64>

The limit that was used for this search. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed.

Example:

1000

offset
integer<int64>

The 0-based offset of the first entry in this set. This will be the same as the offset query parameter used.

Example:

2000

entries
(File (Full) · object | Folder (Full) · object | Web link · object)[]

The search results for the query provided.

A full representation of a file, as can be returned from any file API endpoints by default.