Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Compliance

List Suppressions

API key access

Needs the compliance:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/suppressions

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Query Parameters

kind?SuppressionKind | null
reason?SuppressionReason | null
q?string | null

Value contains

Lengthlength <= 200
cursor?string | null
Lengthlength <= 64
limit?integer
Formatint64
Range1 <= value <= 200

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/suppressions?q=string&cursor=string&limit=1" \  -H "X-Workspace-Id: string"
{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "kind": "email",
      "value": "string",
      "reason": "opt_out",
      "channels": [
        "email"
      ],
      "source": "string",
      "note": "string",
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List Contact Deferrals

What the contact-pressure rules and the resource rate limiters deferred (never dropped): counts per reason (`contact_pressure:*`, `rate_limited:*`) and the latest rows (at most 100), one per lead, channel, reason, source and UTC day.

Opt Out

The lead asked us to stop: revoke consents and suppress their address(es). In-flight sequence enrollments that can no longer reach the lead on any channel they use stop (`opted_out`).