Compliance

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.

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/workspaces/current/contact-pressure/deferrals
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

days?integer

Look back this many days (default 7)

Formatint64
Range1 <= value <= 90
lead_id?string | null

Only this lead

Formatuuid

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/workspaces/current/contact-pressure/deferrals?days=1&lead_id=497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string"
{
  "since": "2019-08-24T14:15:22Z",
  "by_reason": [
    {
      "reason": "string",
      "count": 0,
      "leads": 0
    }
  ],
  "items": [
    {
      "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
      "channel": "email",
      "reason": "contact_pressure:person_min_gap",
      "source": "sequence_runner",
      "count": 0,
      "next_allowed_at": "2019-08-24T14:15:22Z",
      "first_at": "2019-08-24T14:15:22Z",
      "last_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}