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.

Query Parameters

page[number]
integer
default:1

Page number to return (offset pagination)

Required range: x >= 1
page[size]
integer
default:25

Number of records per page

Required range: 1 <= x <= 100
page[after]
string

Cursor for records after the provided value (cursor pagination)

page[before]
string

Cursor for records before the provided value (cursor pagination)

sort
enum<string>

Field to sort by. Prefix with - for descending order.

Available options:
created_at,
-created_at,
domain,
-domain
filter[status]
enum<string>
Available options:
pending,
verifying,
verified,
failed,
degraded,
suspended
filter[domain]
string

Partial match on domain name (case-insensitive)

filter[profile_id]
string<uuid>

Filter by profile UUID

filter[type]
enum<string>
Available options:
custom,
shared,
shared_inbound
filter[usable_for_sending]
boolean
filter[usable_for_inbound]
boolean

Response

A paginated list of email domains

data
object[]
required
meta
object
required