curl --request GET \
--url https://app.famulor.io/api/v1/suppression-list \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/suppression-list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/suppression-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.famulor.io/api/v1/suppression-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/suppression-list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.famulor.io/api/v1/suppression-list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/suppression-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "+4930123456",
"email": "contact@example.com",
"identity_type": "phone",
"identity": "<string>",
"scope": "all",
"origin_channel": "voice",
"purpose": "marketing",
"reason": "Unsubscribe request",
"source": "<string>",
"mode_at_opt_out": "universal",
"direction": "outbound",
"created_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"pagination": {
"limit": 50,
"offset": 0,
"total": 2
}
}
}List suppression entries
Lists active suppressions across voice, SMS, email, and supported messaging channels. Results expose the public contact identity, scope, direction, origin channel, source, and consent mode captured at opt-out. outbound entries are never contacted; inbound entries get no answer to their incoming calls and messages; both combines the two. Required scope: suppression:read (keys without scope restrictions have full access).
curl --request GET \
--url https://app.famulor.io/api/v1/suppression-list \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/suppression-list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/suppression-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.famulor.io/api/v1/suppression-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/suppression-list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.famulor.io/api/v1/suppression-list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/suppression-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phone": "+4930123456",
"email": "contact@example.com",
"identity_type": "phone",
"identity": "<string>",
"scope": "all",
"origin_channel": "voice",
"purpose": "marketing",
"reason": "Unsubscribe request",
"source": "<string>",
"mode_at_opt_out": "universal",
"direction": "outbound",
"created_at": "2023-11-07T05:31:56Z"
}
],
"meta": {
"pagination": {
"limit": 50,
"offset": 0,
"total": 2
}
}
}Authorizations
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
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.
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 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.
outbound, inbound, both "outbound"