Skip to main content
POST
Search contacts by rules

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Body

application/json
rules
object
required

Segment rule tree evaluated against the contact base, e.g. {"kind": "group", "operator": "and", "conditions": [{"kind": "condition", "source": "contact", "field": "state", "operator": "equals", "value": "CA"}]}.

page
integer
default:1

Page number, starting at 1.

Required range: x >= 1
limit
integer
default:25

Results per page (1–100).

Required range: 1 <= x <= 100

Case-insensitive substring match against display name, email, phone, company, first name, and last name, applied on top of rules.

Maximum string length: 255
sort
enum<string>
default:updated_at

Sort key.

Available options:
created_at,
updated_at,
last_activity_at,
display_name,
first_name,
last_name,
normalized_email,
original_source
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

A page of matching contacts.

items
object[]
required

Contacts in this page (without custom_fields).

pagination
object
required

Offset pagination metadata.