List suppressed addresses
List suppressed addresses. View request and response details for this Samva email API endpoint.
GET
Returns the addresses this organization will not send to, newest first, optionally filtered by suppression type, active or expired state, and an address substring. Pass nextCursor back as cursor for the next page; it is null on the last page.
apiKeyheader
x-api-key<token>type?stringValue in
"bounce""complaint""unsubscribe""manual"status?stringValue in
"active""expired"search?stringLength
length <= 256limit?|nullcursor?stringSuppressionPage
application/json- response
items*array<>nextCursor*string|nullimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.listSuppressions({});Example Response
{ "items": [ { "id": "string", "email": "string", "type": "bounce", "bounceType": "string", "bounceSubType": "string", "reason": "string", "messageId": "string", "isActive": true, "expiresAt": "string", "createdAt": "string" } ], "nextCursor": "string"}