v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB
Documents

Search Documents

Search for documents that match the provided search terms.

Keywords are searched for in the name, full_path, user first name, and user last name fields.

Note that the id field in the search results refers to a document ID or a directory ID depending on the node_type attribute.

get/v1/document/

Query parameters

querystring nullable
skipinteger nullable
limitinteger nullable
sort_direction'asc' | 'desc'

Direction to sort the sort_column - ascending or descending.

date_startstring date-time nullable
date_cut_offstring date-time nullable
sort_column'updated_at' | 'created_at' | 'full_path' | 'id'

Sort columns for document search.

directory_idinteger nullable
is_trashedboolean nullable
is_offlineboolean nullable
is_recursiveboolean

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.