List domains

GET/v1/domains

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

Every sending domain in the project, each with its verification state and the DNS records to publish.

Unpaginated. Only domains reaching verified can send; until then a send from an address on them is refused with 403.

Response

All domains with their DNS records.

dataobject[]required
- domainIdstringrequired
- projectIdstring
- domainstringrequired
- statusenumrequired
  pendingverifiedfailed
- dkimStatusenum
  pendingverifiedfailednot_applicable
- spfStatusenum
  pendingverifiedfailed
- dmarcStatusenum
  pendingverifiedfailed
- trackingStatusenum
  pendingverifiedfailed
- mailFromStatusenum
  Custom MAIL FROM subdomain (`bounce.<domain>`) — carries the bounce path and lets DMARC align SPF.
  pendingverifiedfailednot_applicable
- mailFromDomainstring | null
- selectorstring | null
  DKIM selector published at `<selector>._domainkey.<domain>`.
- verifiedForSendingboolean
  Whether the provider will currently accept mail from this domain.
- dkimTokensstring[]
  Legacy SES Easy DKIM CNAME tokens. Empty for domains onboarded with BYODKIM, which publish a single TXT record instead.
- verificationTokenstring | null
- lastCheckedAtstring | null
- createdAtdate-timerequired
- dnsRecordsobject[]required
  The DNS records to install.
  - purposeenumrequired
    ownershipdkimspfdmarctrackingmailfrom
  - typeenumrequired
    TXTCNAMEMX
  - hoststringrequired
  - valuestringrequired
  - statusenumrequired
    pendingverifiedfailednot_applicable

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

401Missing or invalid API key.

Request

curl https://api.volanea.com/v1/domains \
  -H "Authorization: Bearer sk_..."

Response

200 · application/json

{
  "success": true,
  "data": {
    "data": [
      {
        "domainId": "<domainId>",
        "projectId": "<projectId>",
        "domain": "<domain>",
        "status": "pending",
        "dkimStatus": "pending",
        "spfStatus": "pending",
        "dmarcStatus": "pending",
        "trackingStatus": "pending",
        "mailFromStatus": "pending",
        "mailFromDomain": "<mailFromDomain>",
        "selector": "<selector>",
        "verifiedForSending": true,
        "dkimTokens": [
          "<dkimTokens>"
        ],
        "verificationToken": "<verificationToken>",
        "lastCheckedAt": "2026-01-01T09:00:00.000Z",
        "createdAt": "2026-01-01T09:00:00.000Z",
        "dnsRecords": [
          {
            "purpose": null,
            "type": null,
            "host": null,
            "value": null,
            "status": null
          }
        ]
      }
    ]
  }
}

92 endpoints · OpenAPI document