Skip to main content
POST
Search for leads using specified criteria.

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 that serves as a cursor for pagination, indicating where to start returning results.

filterGroups
object[]
required

An array of filter groups used to narrow down the search results based on specified criteria.

limit
integer<int32>
required

An integer specifying the maximum number of results to return.

properties
string[]
required

An array of strings indicating 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.

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 a CRM object in the response.

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