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_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, 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 within the workspace's available capabilities.

Query Parameters

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

channel
enum<string>

Return records scoped to this channel or universal (all), in every direction, so inbound entries can appear. Add direction=outbound to list only outbound entries. 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,
linear,
notion,
twitch,
mattermost,
webex,
lark,
line,
sendblue,
linq,
zernio,
freshdesk,
gmail,
outlook,
zendesk,
servicenow,
intercom,
zoho_mail,
agent_mail,
instagram,
zulip
direction
enum<string>

Return only entries with exactly this direction. inbound does not include both entries; request both separately. outbound: the contact is never called, texted, or emailed (scope applies). inbound: incoming calls from the phone number are hung up immediately and incoming SMS, WhatsApp, other messenger, and email messages from that phone or email get no AI reply and no reply charge; they stay visible in History (incoming SMS and RCS on purchased numbers still cost the normal receive fee). Inbound blocking covers every channel of the identity regardless of scope. both: both. Automatic opt-outs (STOP replies, verbal do-not-call requests, email unsubscribes, imports) are always outbound. Opt-in (for example an SMS START reply) only lifts the outbound part.

Available options:
outbound,
inbound,
both
Example:

"outbound"

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