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 to retrieve the next set of results in a paginated response.

filterGroups
object[]
required

An array of FilterGroup objects that define the filtering criteria for the search. Each FilterGroup contains multiple filters that are combined using logical AND operations.

limit
integer<int32>
required

An integer specifying the maximum number of results to return in the search response.

properties
string[]
required

An array of strings specifying the properties to be included in the search results. Only the specified properties will be returned.

sorts
string[]
required

An array of strings specifying the properties by which the search results should be sorted. The sorting order is determined by the order of the strings in the array.

query
string

A string representing a search query to match against the CRM objects.

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 page.

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