Skip to main content
POST
Preview People

Authorizations

X-API-Key
string
header
required

API Key for authentication

Body

application/json
schemaVersion
string
required

The version the search schema currently reports, e.g. people.v1. Any other value is refused.

Minimum string length: 1
Example:

"people.v1"

query
object
required

The people-search query: the flat list of conditions {"filters":[…]} in the grammar Get Lead Finder Search Schema publishes. A key the grammar does not accept is refused, naming it; no key is dropped silently.

Example:

Response

status
string
required

Response status

Allowed value: "success"
data
object
required

The first page of the people matched, masked, and how many people match in total.

message
string
required

Success message

Example:

"Operation completed successfully"