Search files and folders

post

https://api.safetyculture.io/documents/v1/search

Returns a list of files and folders.

Body Params

Request to search the files and folders.

page_size

int32

The number of items (files and folders combined) to return. Max value is 25. Defaults to 25 if not provided.

page_token

string

The token to retrieve the next page of results. Use the value returned in the `next_page_token`` from the previous response.

include_media_url

boolean

If true, includes a temporary media URL for each file so it can be downloaded.

archived

boolean

If true, only archived files will be returned.

search_term

string

Search term to match against file or folder names. This is case-insensitive, must be 1-130 characters, and exclude invalid characters.

item_ids

array of strings

List of item IDs to filter results. Only items matching any of the IDs will be returned.

item_ids

valid_to

object

TimeInterval to filter by expiry date. If only from is set, it will return files expiring after that date. If only to is set, it will return files expiring before that date. If both are set, it will return files expiring within that time range.

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

defaultAn unexpected error response.