Contacts

List contacts

List contacts with full-text and tag filters.

GET/v1/contacts

Authorization

bearerAuth
AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Query Parameters

limit?integer
Default25
Range1 <= value <= 100
skip?integer
Default0
Range0 <= value <= 9007199254740991
query?string

Full-text match on name + email + phone.

email?string

Exact match, case-insensitive.

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
phone?string

Exact match.

tag?string

Only contacts carrying this tag.

leadStatus?string
Value in"new" | "contacted" | "qualified" | "unqualified" | "converted"
sortBy?string
Default"createdAt"
Value in"createdAt" | "updatedAt" | "lastName" | "firstName"
sortOrder?string
Default"desc"
Value in"asc" | "desc"

Response Body

application/json

application/json

application/json

application/json