API · Suppressions

Retrieve Suppression

Retrieve a suppression by ID or URL-encoded normalized email address (requires full access). The source email ID may be null.

GET/suppressions/{suppression}Full access

Request parameters

Parameter	Type	Description
`suppression` path · required	`string`	The Suppression ID or email address.

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/YOUR_suppression" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

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

json

{
  "object": "suppression",
  "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.