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.

Path Parameters

objectType
string
required

The type of CRM object to search, such as contacts, companies, or deals.

Body

application/json

Describes a search request

after
string
required

A string representing the paging cursor token to retrieve the next set of results.

filterGroups
object[]
required

An array of FilterGroup objects that specify the criteria for filtering the search results.

limit
integer<int32>
required

An integer indicating 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 that define the sorting order of the search results.

query
string

A string representing the search query to be applied to 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 SimplePublicObject items, each representing an individual object in the collection.

total
integer<int32>
required

An integer representing the total number of simple public objects available.

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