Skip to main content
GET
List contacts

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

q
string

Search name, handle, phone or email

lifecycle
string

lead | client | inactive | archived

stage
string<uuid>

Pipeline stage uuid, or 'none' for no stage

tags
string<uuid>

Array of tag ids; matches contacts having any of them

status
string

active | paused | blocked

platform
string

Filter by channel platform

has_phone
boolean

Only contacts with a phone

has_email
boolean

Only contacts with an email

per_page
integer

Items per page (max 100)

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object