Skip to content

List contacts

GET
/contacts

Returns a cursor-paginated list of contacts for the authenticated tenant.

limit
integer
>= 1 <= 100
cursor
string
type
string
search
string
dateFrom
string format: date-time
dateTo
string format: date-time
compact

Return compact row projection (id + key fields only).

boolean

Return compact row projection (id + key fields only).

Contacts page

object
data
required
Array<object>
object
id
required
integer
firstName
required
string | null
lastName
required
string | null
companyName
required
string | null
email
required
string | null format: email
phone
required
string | null
type
required
string
createdAt
required
Any of:
string format: date-time
updatedAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer

Scope insufficient

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string