Skip to main content
GET
List the member's contacts

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Headers

If-None-Match
string

ETag from a previous response.

Query Parameters

filter[group_id]
string<uuid>

Only contacts in this group of the member's.

filter[tag]
string

Only contacts in the member's group with this name.

filter[unread]
boolean

true lists contacts with unread activity. A contact with unread activity whose counter awaits background reconciliation answers 503 rather than being left out.

filter[updated_since]
string<date-time>

Only contacts changed at or after this time.

sort
enum<string>
default:-last_activity_at

last_activity_at, name or created_at; prefix - for descending. Defaults to -last_activity_at, contacts without activity last.

Available options:
last_activity_at,
-last_activity_at,
name,
-name,
created_at,
-created_at
page[cursor]
string

Opaque cursor from meta.pagination.next_cursor. A cursor issued for other filters, another sort or another member restarts at the first page; a malformed, tampered or expired one (older than three days) returns 400.

page[limit]
integer
default:25

Page size. Defaults to 25, at most 100.

Required range: 1 <= x <= 100

Response

One page of contacts.

One page of contacts.

status
integer
required
data
object[]
required
meta
object
required

Envelope metadata present on every response.