Skip to main content
POST
Search people
Required scope: CRM_READ
This endpoint is paginated. Use page and size in the request body to control results. See Pagination.

Request body

Filters

Pass an object with named fields. All provided filters are combined with AND.

Available filter fields

Custom attributes

Each result includes custom_attributes, the values of your custom fields keyed by field key. Always present, {} when there are none, with the same formats as Get person. Custom attributes cannot be used to filter or sort.

Authorizations

Authorization
string
header
required

Body

application/json

Request body for searching people

filters
object | null

Named filters. All are combined with AND.

search
string | null

Free-text search across name, email, phone number, and company

sort
enum<string> | null

Sort order (default: DATE_DESC)

Available options:
DATE_DESC,
DATE_ASC,
NAME_ASC,
NAME_DESC,
CREATED_DESC,
CREATED_ASC
page
integer
default:1

Page number (1-indexed)

size
integer
default:20

Results per page

Required range: x <= 100

Response

Search results

data
object[]
pagination
object