Retrieve a domain

Retrieve a domain

GET/api/v1/email/domains/{id}

GET /email/domains/{id}
curl -X GET 'https://www.unitpost.com/api/v1/email/domains/dom_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "object": "domain",
  "id": "id_123",
  "name": "Example",
  "status": "pending",
  "records": [
    {
      "type": "string",
      "name": "Example",
      "value": "string",
      "priority": 0
    }
  ],
  "dkim_selector": "string",
  "open_tracking": false,
  "click_tracking": false,
  "tls": "opportunistic",
  "tracking_subdomain": "string",
  "tracking_verified_at": "2026-01-01T00:00:00.000Z",
  "capabilities": {
    "sending": "enabled",
    "receiving": "enabled"
  },
  "receiving": {
    "status": "disabled",
    "record": {
      "type": "string",
      "name": "Example",
      "value": "string",
      "priority": 0
    },
    "checks": {
      "mx_found": false,
      "mx_lowest_priority": false,
      "other_mx_found": false
    },
    "checked_at": "2026-01-01T00:00:00.000Z"
  },
  "verified_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve a single sending domain by id, including its current verification status and the DNS records you need to publish. Re-run the DNS check with Verify a domain, or change its tracking/TLS settings with Update a domain. Requires the domains:read capability.

Parameters1 field
FieldTypeDescription
idrequiredstring · path—
Response · 200 fields16 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
statusrequiredenumpending | verifying | verified | degraded | failed—
recordsrequiredobject[] | null—
dkim_selectorrequiredstring | null—
open_trackingrequiredboolean | null—
click_trackingrequiredboolean | null—
tlsrequiredenumopportunistic | enforced—
tracking_subdomainrequiredstring | null—
tracking_verified_atrequiredstring | nullWhen tracked links and open pixels started using the custom tracking host (`tracking_subdomain`). Non-null only while sends actually use it: the domain is verified (or degraded) and the host's last check proved it answers over HTTPS. Otherwise null, and links use the default tracking host. A host that stops answering, or a domain that's no longer verified, goes back to null.
capabilitiesrequiredobject—
receivingrequiredobjectReceiving setup: the MX record to publish and the last check of it.
verified_atrequiredstring | null—
created_atrequiredstring—
updated_atrequiredstring—
200401404

Search docs and guides

Search the docs and product guides.