API · Suppressions

List Suppressions

List suppressed email addresses, optionally filtered by origin (requires full access). The source email ID may be null.

GET/suppressionsFull access

Request parameters

Parameter	Type	Description
`origin` query · optional	`"bounce" \| "complaint" \| "manual"`	Filter suppressions by origin.
`limit` query · optional	`integer` 1–100 Default: 20	Number of items to return.
`after` query · optional	`string`	Return items after this cursor.
`before` query · optional	`string`	Return items before this cursor.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/suppressions" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
      "email": "steve.wozniak@gmail.com",
      "origin": "manual",
      "source_id": "479e3145-dd38-476b-932c-529ceb705947",
      "created_at": "2023-10-06 23:47:56.678+00"
    }
  ]
}

Behavior and errors

Use a suppression ID or URL-encoded email for retrieval and removal. Addresses are trimmed and lowercased. Older automatic entries can have source_id: null. See suppression management.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.