List onboarded domains
GET /v1/admin/orgs/{org_id}/domains
GET
/v1/admin/orgs/{org_id}/domains
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” org_id
required
string
Query Parameters
Section titled “Query Parameters ” limit
integer
Page size for the cursor-paginated agent surface (default 50; clamped to the 1-100 range).
page
string
Opaque page token echoed back from a prior next_page. Used by the legacy offset-paginated admin/console list surface; the cursor-paginated agent surface uses Cursor (?cursor) instead.
Responses
Section titled “ Responses ”Ok
object
domains
Array<object>
object
id
string
domain
string
mode
string
verification_status
string
dkim_status
string
shared
True for the hosted inbox domain included with the current plan.
boolean
provisioning_phase
string
provisioning_error
string
next_page
string
Missing or invalid credential.
The canonical error envelope. error is a stable machine code.
object
error
required
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
string
Example
forbidden message
Human-readable detail (never leaks internals).
string
Example
missing required scope