v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Domains

Get domains

Unified domain read. Omit domainId to LIST the brand’s sending domains under { data, pagination } — ALL lifecycle states by default (so callers mid-verification can read pending rows + their DNS records); pass ?sendableOnly=true for only verified, send-ready domains (the set valid for POST /v1/sends and automation sendEmail nodes). Pass ?domainId= to fetch ONE domain — returns { data: [row] } (no pagination), 404 DOMAIN_NOT_FOUND on an unknown / cross-brand id.

get/v1/domains

Query parameters

domainIdstring

Fetch a single domain by id (detail mode → { data: [row] }). Omit to list.

sendableOnly'true' | 'false'

List mode only — when true, only verified send-ready domains.

limitinteger

Page size (1–100). Defaults to 100.

cursorstring

Opaque pagination cursor echoed from the previous page’s pagination.cursor. Omit for the first page.

Response

A page of domains (list mode), or { data: [row] } (detail mode).