Skip to content

List Domain Mailboxes

GET
/provider-domains/{domain_id}/mailboxes

The mailboxes on one sending domain, a page at a time. Reads only.

GET here although the app spells it POST: it changes nothing, and a read should be cacheable and retryable as one.

Authorizations

Parameters

Path Parameters

domain_id
required

Sending domain id (provider_domains.id) - from GET /provider-domains

integer

Sending domain id (provider_domains.id) - from GET /provider-domains

Query Parameters

start_row

First row, zero-based

integer

First row, zero-based

end_row

Row after the last one returned

integer
default: 100 >= 1 <= 1000

Row after the last one returned

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

A named collection ({"plans": [...]}) keeps its own key AND gains items, so a caller can page every list surface the same way without memorising which key each route chose.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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