Theme switcher

Composite search for documents

Header Parameters

Authorizationstring

Header parameter used to authenticate the API request.

Query Parameters

pageinteger

Query parameter specifying the page number for pagination in the API request.

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

Body Parameters

queryarray

List of search filters. Every search filter must be separated by an OperatorSearch object. SectionSearch objects allow for nesting of filters.

Show child attributes

Response

200
Object
FoundDocument object

Response Attributes

documentsarray

Response parameter indicating the list of documents returned by the API.

Show child attributes

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

The url for the next page of results.

Nullable:
True
previousstring

The url for the previous page of results.

Nullable:
True
400
Object
Invalid request parameters

Response Attributes

errorstring

Response parameter that contains error information if an issue occurs with the API request.

401
Object
Access token is missing or invalid

Response Attributes

errorstring

Response parameter that contains error information if an issue occurs with the API request.

403
Object
Forbidden

Response Attributes

errorstring

Response parameter that contains error information if an issue occurs with the API request.

500
Object
Internal/Unexpected Error

Response Attributes

errorstring

Response parameter that contains error information if an issue occurs with the API request.

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot