Retrieve a domain
/domains/{id}AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
idstring<uuid>requiredDomain with its DNS records; the team's shared subdomain has none (records: [])
idstring<uuid>requirednamestringrequiredstatusstringrequiredcreated_atstringrequiredregionstringrequiredopen_trackingbooleanrequiredclick_trackingbooleanrequiredtracking_subdomainstring | nullrequiredtracking_statusstring | nullrequiredBillionSend extension: where the tracking subdomain stands: pending (waiting for its CNAME and certificate), active (links go through it) or failed (did not activate within 72 hours; links use the shared host). null while no tracking_subdomain is set.
pendingactivefailednulltracking_errorstring | nullrequiredBillionSend extension: why the tracking subdomain is not active, when known
unsubscribe_subdomainstring | nullrequiredBillionSend extension: the domain's own unsubscribe host label, null when unset
unsubscribe_statusstring | nullrequiredBillionSend extension: where the unsubscribe subdomain stands: pending, active (unsubscribe links go through it) or failed (links use the shared host). null while no unsubscribe_subdomain is set. When both subdomains are the same label they share one host and always read the same.
pendingactivefailednullunsubscribe_errorstring | nullrequiredBillionSend extension: why the unsubscribe subdomain is not active, when known
unsubscribe_pageobjectrequiredBillionSend extension: this domain's own look for its unsubscribe pages. A null field falls back to the team's default page, then to the built-in default.
Show propertiesHide properties
brand_namestring | nullrequiredmessagestring | nullrequiredsuccess_messagestring | nullrequiredredirect_urlstring | nullrequiredbackground_colorstring | nullrequiredtext_colorstring | nullrequiredaccent_colorstring | nullrequiredlogo_radiusstring | nullrequiredsquaregentleroundedcirclenulllogo_urlstring | nullrequiredRead-only; uploaded in the dashboard
capabilitiesobjectrequiredShow propertiesHide properties
sendingstringrequiredenabled; on the shared row, disabled while the instance pauses sending from the shared domain
receivingstringrequiredenabled while the domain receives mail; always disabled on an instance that does not
receiving_catch_allbooleanrequiredBillionSend extension: whether mail to an address without an inbox is stored (true) or refused at RCPT (false)
sharedbooleanrequiredBillionSend extension: true on the team's subdomain of the shared inbox domain, a read-only row listed after the team's own domains (403 on changes) that POST /inboxes domain_id takes; false on the team's own domains
sending_modestringBillionSend extension, on the shared row only: what its inboxes' addresses may send. open starts conversations, reply_only replies inside their threads, receive_only sends nothing. Holds on names still apply per send: an address whose username or from_name imitates a brand, or one on an older label that does, replies only, even when the mode is open.
openreply_onlyreceive_onlysending_mode_reasonstring | nullBillionSend extension, on the shared row only: what holds sending below open: the team's plan or the instance; null when open
planinstancenullobjectstringrequireddomainrecordsobject[]requiredShow propertiesHide properties
objectrecordstringrequiredWhich record this is: DKIM, SPF (the MAIL FROM MX and TXT rows), DMARC, Tracking (the tracking subdomain's CNAME, present once a tracking subdomain is set), Unsubscribe (the unsubscribe subdomain's CNAME, present once an unsubscribe subdomain is set to a label other than the tracking one) or Receiving (the MX inbound mail needs, present while receiving is enabled; it reads verified only when it is among the domain's lowest-numbered MX records). Only the DKIM and SPF rows gate sending.
namestringrequiredtypestringrequiredttlstringrequiredstatusstringrequirednot_started | pending | verified | failed. DKIM and SPF rows combine public DNS with the provider's verification: found in DNS but not yet confirmed reads pending, a different published value reads failed, no record reads not_started. DMARC reads verified when a policy covers the domain — its own or a parent domain's (see inherited_from) — and not_started when none does. Tracking and Unsubscribe read verified once their CNAME resolves and its certificate is issued, pending until then, and failed when it did not activate within 72 hours.
valuestringrequiredprioritynumberlivestringWhat public DNS answers for this record right now: found, missing, mismatch (a different value is published) or unknown (the lookup did not conclude). Omitted when no live check ran (the create response).
foundmissingmismatchunknowndetailstringOne sentence explaining a row that is not verified: found but awaiting the provider, the value that is published instead, no record at the name, or which parent DMARC policy covers the domain. Omitted when there is nothing to add.
inherited_fromstringDMARC only: the _dmarc name whose policy covers this domain when it has no record of its own (RFC 7489 organizational-domain fallback).
policystringDMARC only, alongside inherited_from: the inherited policy's p= value.
nonequarantinerejectMissing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredNot found, or a domain other than the one the calling key is held to
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired