Skip to Content

Get a sending domain

Returns a single sending domain, including its DNS records and verification details.

GET
/v1/email/domains/{id}

Returns a single sending domain, including its DNS records and verification details.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^dom_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

EmailDomainDetailed

application/json
  1. response
unknownRecipientMailboxId*|

The active mailbox on this domain that receives unknown addresses when catch-all has no webhook endpoint, or null to drop them without a bounce.

id*EmailDomainId
Match^dom_[0-9a-hjkmnp-tv-z]{16,24}$
domain*string
phase*string
Value in"dns-setup""provisioning""verifying""ready""degraded""failed"
dkimSelector?string|null
dkimPublicKey?string|null
dnsRecords*array<>
verifiedAt*string|null
namespaceId*|

The namespace the domain belongs to, or null at organization level. Namespace callers also reach organization-level domains whose shared flag is true.

shared*boolean
isDefault*boolean
deliverability*

Bounce and complaint rates over the last 24 hours, as fractions between 0 and 1, with windowSends, the deliveries they were divided by, plus sendingStatus, which says whether the organization can currently send. The window matches the one the sending-pause rule reads. Below 200 sends that rule ignores the window entirely, so a rate over a smaller windowSends is a quotient rather than a reading. These are not a lifetime record; an identity with no traffic in the window reports zeroes.

createdAt*string
updatedAt*string
Example Request
import { createClient } from "samva";

const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });

const result = await samva.email.getDomainById({
  "id": "example"
});
Example Response
{
  "unknownRecipientMailboxId": "string",
  "id": "string",
  "domain": "string",
  "phase": "dns-setup",
  "dkimSelector": "string",
  "dkimPublicKey": "string",
  "dnsRecords": [
    {
      "type": "A",
      "name": "string",
      "value": "string",
      "ttl": "string",
      "description": "string",
      "priority": 0
    }
  ],
  "verifiedAt": "string",
  "namespaceId": "string",
  "shared": true,
  "isDefault": true,
  "deliverability": {
    "bounceRate": 0,
    "complaintRate": 0,
    "windowSends": 0,
    "sendingStatus": "enabled"
  },
  "createdAt": "string",
  "updatedAt": "string"
}

Related documentation