Skip to main content
GET
Search 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.

Query Parameters

q
string
required

Search text, 2 to 100 characters, not only whitespace and without null bytes.

Required string length: 2 - 100
Pattern: ^[^\u0000]*$
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 matching contacts.

One page of contacts.

status
integer
required
data
object[]
required
meta
object
required

Envelope metadata present on every response.