Skip to main content
GET
List inbound email addresses

Authorizations

Authorization
string
header
required

API key or access token

Query Parameters

status
enum<string>
default:active

active (default) lists only addresses that currently receive mail; all also lists revoked addresses.

Available options:
active,
all
take
integer
default:100

Maximum number of addresses to return (1-500, default 100)

Required range: 1 <= x <= 500
skip
integer
default:0

Number of addresses to skip, for paging

Required range: 0 <= x <= 9007199254740991

Response

List inbound email addresses

addresses
object[]
required

One page of the account’s inbound email addresses, newest first. Each address appears once, at its latest revision.

total
integer
required

Number of addresses matching the status filter

Required range: 0 <= x <= 9007199254740991