Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

A workspace API token (sk_live_...) or an OAuth access token (oat_live_...). Create workspace tokens in Settings > API. Send either as Authorization: Bearer <token>.

Query Parameters

limit
integer
default:50

Items per page (max 200).

Required range: 1 <= x <= 200
cursor
string | null

Opaque cursor from a previous response's links.next.

sort
string | null

Comma-separated ordering keys; prefix with - for descending. Results are always totally ordered, and paging never repeats or skips a row even while records change.

Example:

"-updated_at"

expand
string | null

Comma-separated relationships to inline in the response, e.g. organization. Unexpanded relations are still identified by their *_id field.

Example:

"organization"

fields
string | null

Comma-separated fields to return. object and id are always included. Reduces payload size, not query cost.

Example:

"name,email,organization_id"

status
enum<string>[] | null

Repeat to OR.

Maximum array length: 100

Where a contact stands commercially.

Available options:
open,
on_hold,
won,
lost
score
enum<string>[] | null

Repeat to OR.

Maximum array length: 100

How warm a contact is.

Available options:
cold,
warm,
hot
email
string[] | null

Exact email. Repeat to OR.

Maximum array length: 100
owner_id
string[] | null

Owned by this teammate. Repeat to OR.

Maximum array length: 100

Unique identifier for an user.

Pattern: ^usr_[0-9a-f]{32}$
organization_id
string[] | null

Belonging to this organization. Repeat to OR.

Maximum array length: 100

Unique identifier for an organization.

Pattern: ^org_[0-9a-f]{32}$
external_id
string[] | null

Your own id for the record, as set in external_id. Repeat to OR.

Maximum array length: 100
updated_since
string<date-time> | null

Only records changed at or after this instant, with a timezone offset. Pair with sort=updated_at to walk changes in order.

Example:

"2026-09-01T00:00:00Z"

created_since
string<date-time> | null

Only records created at or after this instant.

Example:

"2026-09-01T00:00:00Z"

Response

Successful Response

A page of contacts.

data
Contact · object[]
required
meta
PageMeta · object
required