Simple search for documents
Header Parameters
Header parameter for authenticating the API request.
Query Parameters
Determines the type of search to perform
simpletextbooleanfieldfolderprovisionThe term or terms on which you're searching. If the type is "simpletext", this may be repeated.
Needed by some queries for type "field" searches that require multiple arguments.
Required for type "simpletext" searches. Specifies where to look for the given text.
filenamecontentbothRequired for type "folder" searches instead of argument "terms". Is an array of full folder paths. Each folder is expected to start with "Documents/".
Specifies the exact filtering behavior. The valid options vary depending on the type of search and, for "field" searches, the underlying type of the field.:
- All Fields
isblank- Field is emptynotisblank- Field is not empty
- Datetime Fields
before- Field is before the given dateafter- Field is after the given dateon- Field is on the given datebetween- Field is between two given datesnext- Field is in the next ...
containsanycontainsallcontainsexactnotcontainsanynotcontainsallnotcontainsexactisblanknotisblankequalsnotequals... 13 other enums
Query parameter specifying the page number for document retrieval.
Specify the number of results per page.
Response
Response Attributes
Response parameter providing information on the documents found.
Show child attributes
The total number of unique documents found in the search. If this is larger than the page size, additional results can be found on other pages.
The url for the next page of results.
The url for the previous page of results.
Response Attributes
Response parameter signaling any errors encountered during processing.
Response Attributes
Response parameter signaling any errors encountered during processing.
Response Attributes
Response parameter signaling any errors encountered during processing.
Response Attributes
Response parameter signaling any errors encountered during processing.
Response