Theme switcher

Simple search for documents

Header Parameters

Authorizationstring

Query Parameters

typestring Required

Determines the type of search to perform

Enum values:
simpletextbooleanfieldfolderprovision
termsstring

The term or terms on which you're searching. If the type is "simpletext", this may be repeated.

additionalstring

Needed by some queries for type "field" searches that require multiple arguments.

categorystring

Required for type "simpletext" searches. Specifies where to look for the given text.

Enum values:
filenamecontentboth
foldersarray

Required for type "folder" searches instead of argument "terms". Is an array of full folder paths. Each folder is expected to start with "Documents/".

filterstring Required

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 empty
    • notisblank - Field is not empty
  • Datetime Fields
    • before - Field is before the given date
    • after - Field is after the given date
    • on - Field is on the given date
    • between - Field is between two given dates
    • next - Field is in the next ...
Enum values:
containsanycontainsallcontainsexactnotcontainsanynotcontainsallnotcontainsexactisblanknotisblankequalsnotequals
... 13 other enums
pageinteger
Minimum
1
Default value
1
pageSizeinteger

Specify the number of results per page.

Minimum
1
Maximum
200
Default value
100
includeMappingboolean
Default value
false
returnUniqueFieldValuesboolean
Default value
false

Response

200
Object

FoundDocument object

Response Attributes

documentsarray
countinteger

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.

nextstring | null

The url for the next page of results.

previousstring | null

The url for the previous page of results.

400
Object

Invalid request parameters

Response Attributes

errorstring
401
Object

Access token is missing or invalid

Response Attributes

errorstring
403
Object

Forbidden

Response Attributes

errorstring
500
Object

Internal/Unexpected Error

Response Attributes

errorstring
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?