ResellerHQ
Log inTry the sandbox free
GuidesAPI reference
MailboxesDomains

List mailbox domains

GET
/v1/mailbox-domains

Your connected domains, newest first.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Query Parameters

limit?integer

How many to return

Range1 <= value <= 100
Default25
cursor?string

nextCursor from the previous page

status?string

awaiting_domain while a domain bought with the order is still being registered; awaiting_nameservers until the domain points at nameservers; propagating once we have pointed a domain held here ourselves; active when mailboxes can be set up on it; failed when it never pointed there in time (regenerate the nameservers and try again); deleting then deleted once you delete it

Value in"awaiting_domain""awaiting_nameservers""propagating""active""failed""deleting""deleted"
customerId?string
q?string

Text to look for anywhere in the domain

Length1 <= length <= 100

Response Body

Success

application/json
  1. response

Success

data*array<>
nextCursor*|

Pass as cursor for the next page. null on the last page

total*integer

How many match across every page

Range0 <= value
curl -X GET "https://example.com/v1/mailbox-domains?customerId=cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA"
{  "data": [    {      "id": "mdm_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "domain": "northwind-mail.com",      "status": "awaiting_domain",      "source": "resellerhq",      "domainId": "dom_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "nameserversManaged": true,      "nameservers": [        "ns1.example-dns.net"      ],      "failure": {        "code": "DOMAIN_IN_USE_GOOGLE",        "message": "Domain is already in use in Google Workspace."      },      "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "unitPrice": 450,      "customerPrice": 450,      "periodEndsAt": "2026-10-07T11:04:31.000Z",      "unpaidSince": "2026-10-07T11:04:31.000Z",      "deletesAt": "2026-10-07T11:04:31.000Z",      "forwarding": {        "url": "https://northwind.com",        "captcha": true      },      "dmarc": {        "reportingEmail": "string",        "policy": "none",        "subdomainPolicy": "none",        "percentage": 0      },      "actor": {        "kind": "user",        "label": "string"      },      "createdAt": "2026-10-07T11:04:31.000Z"    }  ],  "nextCursor": null,  "total": 1}

Connect a domain POST

Connects a domain without ordering anything, for when you want its nameservers before you buy: most often a domain registered elsewhere, so they can be set at its registrar ahead of time. Not needed otherwise: ordering mailboxes connects the domain by itself. Free.

Get a mailbox domain GET

Next Page