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 to retrieve results after a specific point.

filterGroups
object[]
required

An array of filter groups used to specify the criteria for filtering CRM objects.

limit
integer<int32>
required

An integer defining the maximum number of results to return.

properties
string[]
required

An array of strings specifying which properties of the CRM objects should be included in the search results.

sorts
string[]
required

An array of strings indicating the properties by which the search results should be sorted.

query
string

A string representing the search query to be matched against CRM object 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 a CRM object with basic properties.

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 9, 2026