Skip to content

Search documentation

Search pages and sections

API reference

Domains

Read your sending domains, their verification status and the DNS records they need.

Domains are added and verified in the dashboard (see Sending domains & DNS). The API exposes them read-only so your deployment scripts and health checks can confirm a domain is ready.

The domain object

{
  "id": "dom_01jd3p5w2x8k4m7t1r9b6n0c3q",
  "name": "acme.com",
  "status": "verified",
  "mail_from_domain": "send.acme.com",
  "tracking_domain": "track.acme.com",
  "sending_enabled": true,
  "receiving_enabled": false,
  "tracking_enabled": true,
  "capabilities": {
    "sending":   { "enabled": true,  "ready": true },
    "receiving": { "enabled": false, "ready": false },
    "tracking":  { "enabled": true,  "ready": true }
  },
  "checks": { "ownership": true, "dkim": true, "spf": true, "mail_from": true, "dmarc": false },
  "records": [
    { "purpose": "dkim", "requirement": "required", "type": "TXT", "host": "hulaki._domainkey.acme.com", "value": "v=DKIM1; k=rsa; p=MIIBIjANBg…", "status": "verified" }
  ],
  "verified_at": "2026-11-12T10:04:31Z",
  "last_checked_at": "2026-11-15T06:00:02Z",
  "created_at": "2026-11-12T09:58:10Z"
}
statusstring
pending, verified, temporary_failure or failed. See statuses.
capabilities.*.readyboolean
Whether sending, receiving or tracking can be used right now.
checksobject
Result of the latest DNS check per mechanism.
recordsobject[]
Every DNS record for the domain with purpose, requirement (required, recommended, optional), host, value and status.

List domains

GET/api/v1/domainsscope: domains:read

Returns domains sorted by name, paginated with page and per_page (default 50).

Retrieve a domain

GET/api/v1/domains/{id_or_name}scope: domains:read

Look up by ID (dom_…) or by name (acme.com). Unknown domains return 404 domain_not_found.

curl https://hulakimail.com/api/v1/domains/acme.com \
  -H "Authorization: Bearer $HULAKIMAIL_API_KEY"

Something unclear or missing? Tell us.