Skip to Content
GET
/api/v1/suppressions

Lists deployment-global suppressions for system callers. With accountId, lists that account's complaints; account callers may select only their own account.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Two credential kinds share this scheme; GET /api/v1/auth/whoami answers which one you hold and what it reaches.

oek_… API key (minted by POST /api/v1/api-keys; shown once at mint). role: account reaches the full account surface: the directory (domains, routes, patterns, api-keys, accounts, address lists) plus every mailbox the account owns. role: system additionally reaches the operator surface, which is documented separately.

oemp_… mailbox app password (minted by POST /api/v1/identities/{identityId}/credentials). Reaches ONE mailbox: its messages, labels, threads, search, sync, send, filters and PIM collections. Directory routes refuse it with 403 insufficient_scope.

Refusal vocabulary: a missing, malformed, expired, or revoked credential answers 401 unauthorized with a WWW-Authenticate: Bearer challenge; a VALID credential outside its scope answers 403 (insufficient_scope for an app password on a directory route, system_credentials_required where only the operator may call). The public routes (health, branding, token-in-path capabilities) declare security: [].

Query Parameters

limit?integer

Page size (default 100)

Range1 <= value <= 200
cursor?string

Opaque page cursor from a previous response

accountId?string

Sending account whose complaint suppressions to inspect or modify

Length1 <= length <= 128

Response Body

List of suppressed email addresses

application/json
  1. response
nextCursor?string

Opaque cursor for the next page; absent on the last page

suppressions*array<>
Example Request
curl -X GET 'https://api.open.email/api/v1/suppressions'
Example Response
{
  "nextCursor": "string",
  "suppressions": [
    {
      "accountId": "string",
      "address": "string",
      "detail": "string",
      "eventCount": 0,
      "firstEventAt": 0,
      "lastEventAt": 0,
      "reason": "complaint",
      "sourceDeliveryId": "string"
    }
  ]
}