List domains
Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones. The team’s subdomain of the shared domain, when it has one, is the last row (shared: true).
/domainsAuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
limitintegerPage size, 1-100 (default 20)
afterstring<uuid>Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.
beforestring<uuid>Cursor: id of the first item of the current page; returns the previous page; same rule as after.
Domains
objectstringrequiredlistdataobject[]requiredShow propertiesHide properties
objectidstring<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
planinstancenullhas_morebooleanrequiredMissing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredValidation error
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired