List suppressed addresses

List suppressed addresses. View request and response details for this Samva email API endpoint.

GET
/v1/email/suppressions

Returns the addresses this workspace will not send to, newest first, optionally filtered by suppression type, active or expired state, and an address substring, with limit and offset paging.

x-api-key<token>

In: header

Query Parameters

type?|null
status?|null
search?|null
limit?string|null
offset?string|null

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/email/suppressions"
{  "suppressions": [    {      "id": "string",      "email": "string",      "type": "bounce",      "bounceType": "string",      "bounceSubType": "string",      "reason": "string",      "messageId": "string",      "isActive": true,      "expiresAt": "string",      "createdAt": "string"    }  ],  "total": 0}