Skip to main content
GET
List contacts

Authorizations

next-auth.session-token
string
cookie
required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Query Parameters

workspaceId
string<cuid2>
required

Workspace identifier.

limit
integer
default:50

Page size (max 250).

Required range: 1 <= x <= 250
cursor
string

Opaque cursor returned as meta.nextCursor from the previous page.

includeTotalCount
boolean
default:false

Whether to calculate meta.totalCount. Send true on the first page to get the count; when omitted or false the count query is skipped and meta.totalCount is null.

Case-insensitive substring match over any attribute value of the contact, or its id.

Maximum string length: 512
sortBy
enum<string>
default:-createdAt

-createdAt (newest first, default) or createdAt (oldest first).

Available options:
-createdAt,
createdAt
filter[createdAt][gte]
string<date-time>

Only contacts created at or after this instant (ISO 8601 with offset).

filter[createdAt][lte]
string<date-time>

Only contacts created at or before this instant (ISO 8601 with offset).

Response

Contacts retrieved successfully

data
object[]
required
meta
object
required

A list meta carrying pagination and the filtered total. totalCount is required but nullable, gated on the operation's includeTotalCount parameter.