Skip to main content
GET
List suppression entries

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Query Parameters

Filter by phone number, email, identity, or reason (substring match).

channel
enum<string>

Return records that block this channel, including universal (all) suppressions. Communication channel where an opt-out originated or on which suppression should be evaluated.

Available options:
voice,
sms,
email,
telegram,
slack,
messenger,
teams,
discord,
gchat,
x,
whatsapp
limit
integer
default:50

Page size (1–200).

Required range: 1 <= x <= 200
offset
integer
default:0

Number of items to skip.

Required range: x >= 0

Response

A page of suppression entries.

data
object[]
required
meta
object