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 for pagination. It is used to retrieve the next set of results after the current page.

filterGroups
object[]
required

An array of filter groups used to define the search criteria. Each filter group contains filters that determine which CRM objects are included in the search results.

limit
integer<int32>
required

An integer indicating the maximum number of results to return per page. This property controls the pagination of the search results.

properties
string[]
required

An array of strings specifying the properties of the CRM objects 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 sorting order of the search results. Each string represents a property by which the results should be sorted.

query
string

A string representing a search query to filter the CRM objects. This is an optional field that can be used to perform a text-based search.

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