GET
/suppressionsGET /suppressions
List every address the platform will refuse to send to, with the reason, the source and the timestamp.
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
| Name | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Zero-indexed page number. Defaults to 0. |
| limit | integer | No | Items per page. |
| string | No | Partial match on the address. | |
| tier | HARD | CONSENT | No | HARD is a bounce or a complaint and blocks every channel including transactional. CONSENT is an opt-out and blocks marketing only. |
| reason | string | No | One of manual, one_click, complaint, bounce, admin. |
| source | string | No | Who 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.