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

filterGroups
object[]
required

An array of filter groups to apply to the search. Each filter group contains filters that define specific conditions for the search.

limit
integer<int32>
required

An integer indicating the maximum number of results to return. This property helps control the page size of the search results.

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 specifying the sort order of the search results. Each string represents a property to sort by, optionally followed by a direction (e.g., 'propertyName ASC').

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 of simple public objects included in the current page of 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