Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....

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, so paging never repeats a row.

Example:

"-updated_at"

expand
string | null

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

Example:

"organization,owner"

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"

Response

Successful Response

A page of contacts.

A named subclass purely so the generated SDK type is ContactList rather than the Page_Contact_ FastAPI derives from the generic.

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