Skip to content

List Provider Domains

GET
/provider-domains

List the org’s sending domains.

This is the discovery route: every per-domain endpoint below needs a domain_id from here first. Mirrors the core of the app’s own POST /provider-domains/fetch (mailbox count via a correlated subquery), without its ag-grid filter/sort surface.

Authorizations

Parameters

Query Parameters

page
integer
default: 1 >= 1
limit
integer
default: 20 >= 1 <= 100

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
Array<object>

A sending domain owned (or connected) by the org.

object
created_at
Any of:
string
created_by
Any of:
string
dns_zone_created
boolean
domain
required
string
expires_at
Any of:
string
id
required
integer
is_external
boolean
is_transfer
boolean
mailbox_count
integer
provider_connected
required

Whether this domain is connected to the managed mailbox-provisioning backend. Required before checkout-mailboxes will succeed for a managed purchase — connect it first with POST …/connect-provider.

boolean
purchase_date
Any of:
string
purchase_period
Any of:
integer
source
required

How the domain entered the org, e.g. purchased | transferred | external

string
status
Any of:
string
updated_at
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string