Sign in

v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Domains

Retrieve a domain by name

Returns the domain configuration and the DNS records that must be in place. This is a pure read; call domains.verify to refresh verification status from DNS.

get/v1/domains/{domain}

Path parameters

domainstring required

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

_idstring required
namestring required
status'pending' | 'verified' required
mxRecordConfiguredboolean required
dnsProviderstring
_environmentIdstring required
_organizationIdstring required
createdAtstring required
updatedAtstring required
dataobject

String key-value metadata (max 10 keys, 500 characters total when set via API).

Example response

{
  "expectedDnsRecords": [
    {
      "type": "MX",
      "name": "inbound",
      "content": "inbound-smtp.us-east-1.amazonaws.com",
      "ttl": "Auto",
      "priority": 10
    }
  ]
}