List sending domains

Returns the organization's sending domains, newest first.

GET
/v1/email/domains

Returns the organization's sending domains, newest first. A namespace-scoped key lists only its namespace's domains; an organization-wide caller lists every domain, or one namespace's with namespaceId. Pass nextCursor back as cursor for the next page; it is null on the last page. sendable=true lists only domains a send can use now: active, and verified, or verified before and degraded since. Each row carries deliverability (bounce and complaint rates over the last 24 hours, the window the 5% bounce limit is enforced over) and series, the last 14 days of daily email sends attributed to the domain, oldest first.

Authorization

apiKey
headerx-api-key<token>

Query Parameters

limit?|null
cursor?string
sendable?boolean|null
namespaceId?string
Match^ns_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

EmailDomainPage

application/json
  1. response
items*array<>
nextCursor*string|null
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.listDomains({});
Example Response
{  "items": [    {      "unknownRecipientMailboxId": "string",      "id": "string",      "domain": "string",      "phase": "dns-setup",      "dkimSelector": "string",      "dkimPublicKey": "string",      "namespaceId": "string",      "isDefault": true,      "deliverability": {        "bounceRate": 0,        "complaintRate": 0,        "windowSends": 0,        "sendingStatus": "enabled"      },      "series": [        0      ],      "createdAt": "string",      "updatedAt": "string"    }  ],  "nextCursor": "string"}

Related documentation