Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

email_id
string<uuid>
required

Email message UUID.

Query Parameters

page_size
integer
default:25

Number of results to return. Defaults to 25; maximum is 100. Invalid values are clamped to the valid range.

Required range: 1 <= x <= 100
page_cursor
string

Opaque URL-safe Base64 cursor returned by a previous list response.

status
enum<string>

Filter recipients by status.

Available options:
queued,
sending,
sent,
deferred,
delivered,
bounced,
failed,
gw_reject,
cancelled
kind
enum<string>

Filter recipients by address kind.

Available options:
to,
cc,
bcc

Response

Paginated list of recipients.

data
object[]
required
meta
object
required