Hoppa till innehållet

List the suppressed addresses

GET/v1/suppressions

TypeScript sendora.suppressions.list(query)

Python sendora.suppressions.list(stream_id=..., limit=..., after=...)

Key sk_… a server key

Addresses a stream of the server will not send to: hard bounces, spam complaints and entries added by hand, newest first, one page at a time. The default stream unless streamId names another; every stream has a list of its own. A send to any of them is refused with recipient_suppressed.

Parameters

  • streamIdin querystring (uuid)

    The stream whose list is meant; the default transactional stream when absent.

  • limitin queryinteger (1 to 1000)

    Page size, 1 to 1000.

  • afterin querystring (uuid)

    The next value of the previous page.

Responses

200A page of the stream's suppression list, newest first.

  • suppressionsarray of objectrequired
    • streamIdstring (uuid)required

      The stream whose list the address is on.

    • addressstringrequired

      The recipient, lower-cased.

    • reason"hard_bounce" | "spam_complaint" | "manual" | "unsubscribe"required

      A hard bounce or a manual entry may be lifted here; a spam complaint or the recipient’s own unsubscribe only by Sendora support. manual is an address added by hand in the dashboard.

    • messageIdstring (uuid) or nullrequired

      The message whose bounce or complaint put it here.

    • createdAtstring (date-time)required
  • nextstring (uuid) or nullrequired

    Pass as after for the next page; null on the last.

Example

{
  "suppressions": [
    {
      "streamId": "3d1a2b4c-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "address": "anna@example.com",
      "reason": "hard_bounce",
      "messageId": "5f432ffd-c005-499b-aa3a-5b8a088ea20e",
      "createdAt": "2026-09-15T12:00:00.000Z"
    }
  ],
  "next": null
}

Errors

Every error answers error, the code, and message, a sentence for a person. A code that adds fields is shown in full below the table.

CodeStatusMeaning
invalid_request400The body, the query or a header does not match what the route takes.
unauthorized401The key is missing, malformed or revoked.
wrong_token_kind403The key is of the other kind: a server key (sk_) where an account key (ak_) is needed, or the reverse. The message names the kind the operation takes.
stream_not_found422The streamId names no stream of this server.
stream_not_sendable422An inbound stream receives mail; it takes no messages and has no suppression list. Name a transactional or broadcast stream.

invalid_request

  • issuesarray of object

    One entry per invalid field; absent when a header is wrong.

    • pathstringrequired

      The field, dotted, such as to.0.email; empty when the whole body is wrong.

    • messagestringrequired

Example

{
  "error": "invalid_request",
  "message": "The request is invalid: to.0: Invalid email address",
  "issues": [
    {
      "path": "to.0",
      "message": "Invalid email address"
    }
  ]
}