Look up one address or suppression

GET/v1/suppressions/{id}

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

Path form of GET /v1/suppressions/check, accepting either a suppression id or a URL-encoded email address.

Use it as a pre-send check. Note that a clean result here does not by itself mean a send will go out: POST /v1/send also skips a recipient whose contact is unsubscribed (skipped: "unsubscribed"), which is a different record from a suppression.

Path parameters

idstringrequired
Suppression id, or a URL-encoded email address.

Response

Whether the address is suppressed. Not being suppressed is a 200, not a 404 — a 404 would be ambiguous with a missing route.

suppressedbooleanrequired
suppressionobject | null
Null when the address is not suppressed.

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

401Missing or invalid API key.
422Request validation failed (code `validation_error`, 422).

Request

curl https://api.volanea.com/v1/suppressions/id_123 \
  -H "Authorization: Bearer sk_..."

Response

200 · application/json

{
  "success": true,
  "data": {
    "suppressed": true,
    "suppression": {
      "suppressionId": "<suppressionId>",
      "projectId": "<projectId>",
      "email": "ada@example.com",
      "reason": "hard_bounce",
      "source": "<source>",
      "createdAt": "2026-01-01T09:00:00.000Z"
    }
  }
}

92 endpoints · OpenAPI document