domains

Get custom domain

Retrieve a single custom domain by its ID, including its verification status and the DNS records to publish. Poll this after adding a domain to watch it flip to verified.

get/v1/domains/{id}

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/domains/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Custom domain details

idstring

OpenMail domain ID

domainstring

The domain or subdomain, e.g. example.com or agent-mail.example.com.

podIdstring nullable

Pod this domain is scoped to, so only inboxes in that pod can use it, or null for an account-wide domain.

status'pending' | 'verifying' | 'verified' | 'failed' | 'under_review'

pending — added, records not yet published. verifying — being checked. verified — sending and receiving enabled. failed — records missing or wrong; publishing them and calling verify again is the fix. under_review — flagged as suspicious; DNS setup is blocked until approved.

verifiedAtstring date-time nullable
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.