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 used as a paging cursor token. It represents the last successfully read resource and is used to fetch the next set of results in a paged response.

filterGroups
object[]
required

An array of filter groups used to narrow down the search results. Each filter group can contain multiple filters that are applied together.

limit
integer<int32>
required

An integer indicating the maximum number of results to return. This helps control the size of the result set.

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 objects, it will be ignored.

sorts
string[]
required

An array of strings specifying the sort order of the search results. Each string represents a property to sort by, with optional direction (e.g., 'propertyName ASC' or 'propertyName DESC').

query
string

A string representing a search query to match against the objects' 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 of SimplePublicObject items, each representing an individual object in the collection.

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