Skip to main content
POST
Search objects

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 retrieving the next set of results. This is used for pagination in search results.

filterGroups
object[]
required

An array of filter groups used to specify the criteria for filtering the search results. Each filter group contains multiple filters that are applied together.

limit
integer<int32>
required

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

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 indicating the sorting order of the search results. Each string specifies a property to sort by, optionally prefixed with a '-' to indicate descending order.

query
string

A string representing a search query to match against the CRM objects. This is 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 of SimplePublicObject items, each representing a CRM object.

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