GET/suppressions

GET /suppressions

List every address the platform will refuse to send to, with the reason, the source and the timestamp.

View as Markdown

Request

curl -X GET 'https://api.sendheron.com/api/v1/suppressions' \
  -H 'Authorization: Bearer <YOUR_API_KEY>' \
  -H 'Content-Type: application/json'

Required scopes

The key must carry these:

  • suppressions:read

Query parameters

NameTypeRequiredDescription
pageintegerNoZero-indexed page number. Defaults to 0.
limitintegerNoItems per page.
emailstringNoPartial match on the address.
tierHARD | CONSENTNoHARD is a bounce or a complaint and blocks every channel including transactional. CONSENT is an opt-out and blocks marketing only.
reasonstringNoOne of manual, one_click, complaint, bounce, admin.
sourcestringNoWho put it there: PROVIDER_WEBHOOK, RECIPIENT, DASHBOARD, API or SYSTEM. Distinct from the reason, which is why we will not send.

Responses

Returns 200 on success.

400
The payload failed validation, or the request is not valid for the current state.
401
Missing or invalid API key.
403
Valid key, but it does not carry the required scope.
404
No such record in this workspace.
409
A duplicate, or an idempotency key reused with a different payload.
429
Either rate-limit ceiling was exceeded.

Rate limits

100/min per key, counted against the organization's READ ceiling (1200/min). Both windows are one minute. There is no hourly or daily quota.