List senders

Returns senders, newest first. View request and response details for this Samva email API endpoint.

GET
/v1/email/senders

Returns senders, newest first. A namespace-scoped key lists only its namespace's senders; an organization-wide caller lists every sender, or one namespace's with namespaceId. Optionally filtered by verification status, active state, or default flag. Pass nextCursor back as cursor for the next page; it is null on the last page. Each row carries deliverability (bounce and complaint rates over the last 24 hours) and series, the last 14 days of daily email sends from the address, oldest first.

Authorization

apiKey
headerx-api-key<token>

Query Parameters

limit?|null
cursor?string
verificationStatus?string
Value in"pending""verified""failed"
isActive?boolean|null
isDefault?boolean|null
namespaceId?string
Match^ns_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

EmailSenderPage

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.listSenders({});
Example Response
{  "items": [    {      "id": "string",      "organizationId": "string",      "email": "string",      "name": "string",      "domainId": "string",      "namespaceId": "string",      "verificationStatus": "pending",      "verifiedAt": "string",      "verificationToken": "string",      "providerLifecycle": "provisioning",      "providerFailureCode": "string",      "isDefault": true,      "replyToEmails": [        "string"      ],      "deliverability": {        "bounceRate": 0,        "complaintRate": 0,        "windowSends": 0,        "sendingStatus": "enabled"      },      "series": [        0      ],      "isActive": true,      "createdAt": "string",      "updatedAt": "string"    }  ],  "nextCursor": "string"}

Related documentation