Domain
List Domains
GET /v1/domain
GET
/v1/domainGET
/v1/domain
List all purchased domains and mailboxes with provisioning status
List all domains and mailboxes purchased for the account, with provisioning status.
Use this to check whether async provisioning has completed after calling POST /v1/domain. Poll until status changes from inProgress to active.
Status values observed: inProgress (provisioning in progress), active (provisioned and live), deleted (domain removed), failed, expired.
Use domains[].id as the id in DELETE /v1/domain/{id} or POST /v1/domain/{id}/revoke.
Authorization
x-api-key<token>
API key for Open API authentication
In: header
Query Parameters
searchstring
Filter by domain name (partial match).
orderstring
Sort order. "Asc" = ascending, "Desc" = descending. Default ascending.
Value in:"Asc" | "Desc"Responses
200
Domains fetched successfully