Skip to main content
GET
List Contacts

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.

Path Parameters

id
string
required

Resource ID

Query Parameters

limit
integer
default:50

Rows per page, 1-200.

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

Opaque cursor from the previous page's next_cursor.

Maximum string length: 4096
status
enum<string>
Available options:
subscribed,
unsubscribed,
bounced,
complained,
invalid,
sunset

Case-insensitive substring match on the address.

Maximum string length: 320

Response

A page of contacts.

success
boolean
required
data
object
required