Skip to main content
POST
Search

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Describes a search request

after
string
required

A string representing the paging cursor token of the last successfully read resource. This token is used for pagination to retrieve the next set of results.

filterGroups
object[]
required

An array of filter groups used to specify the search criteria. Each filter group contains multiple filters that define the conditions for the search.

limit
integer<int32>
required

An integer specifying the maximum number of results to return. This value controls the page size of the search results.

properties
string[]
required

An array of strings specifying the properties to be returned in the search results. If a specified property is not present on the requested object(s), it will be ignored.

sorts
string[]
required

An array of strings that define the sorting order of the search results. Each string specifies a property to sort by, optionally followed by a direction (e.g., 'propertyName ASC').

query
string

A string used to perform a full-text search across the specified properties.

Response

successful operation

Represents a list of simple objects returned from an API request, along with the total count of objects available.

results
object[]
required

An array containing the simple public objects returned in the current response.

total
integer<int32>
required

The number of available results

paging
object

Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.

Last modified on September 14, 2026