Retrieve the suppression list summary

View as Markdown
Returns how many numbers are on the workspace suppression list, grouped by `source`. It also lists the national registries (`registry:*`) whose newest row is more than 31 days old (`stale`). Thirty-one days is the US National DNC scrub rule. The numbers themselves are never returned. Sources include the registry imports (`registry:rne_co`, `registry:dnc_us`, `registry:repep_mx`, `registry:nmp_br`) and `customer_list`, as well as sources written automatically when a person opts out: `voice` (a do-not-call request heard on a call), `whatsapp` (a STOP keyword or voice note), and the social channel ids. **Staleness caveat.** `lastImportedAt` and `stale` are based on the newest **row** from each source. Numbers already on the list are not re-inserted on import, so re-importing a registry that contains no new numbers does not move `lastImportedAt`. The registry can still show as stale even though you scrubbed it today. Staleness is reported only. Calls are not blocked because a registry is stale. **Access** - **Required scope:** `full`. Signed-in users need the `owner` or `admin` role. - **Rate limit:** General API — 120 (Starter), 200 (Growth), 300 (Business) or 600 (Enterprise) requests/min per workspace. See [Rate limits](/rate-limits). - **Plan:** Available on every plan.

Authentication

AuthorizationBearer
Workspace API key: `jl_` followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (**Settings → API Keys**) and sent as `Authorization: Bearer jl_...`. The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys. | Scope | GET / HEAD | POST / PUT / PATCH / DELETE | Admin-only routes | | --- | --- | --- | --- | | `read` | Yes | No | No | | `write` | Yes | Yes | No | | `full` | Yes | Yes | Yes | Operations restricted to admins or owners reject keys without the `full` scope with `403`, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See [Authentication](/authentication).

Response

Suppression summary.
dataobject
Counts on the suppression list. The numbers themselves are never returned.

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error