List suppression rules
curl --request GET \
--url https://api.aws53.cloud/v1/data/suppression-rules \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.aws53.cloud/v1/data/suppression-rules"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.aws53.cloud/v1/data/suppression-rules', 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://api.aws53.cloud/v1/data/suppression-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://api.aws53.cloud/v1/data/suppression-rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aws53.cloud/v1/data/suppression-rules")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aws53.cloud/v1/data/suppression-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "email",
"value": "<string>",
"createdAt": "<string>"
}
],
"counts": {
"email": 123,
"domain": 123,
"company_domain": 123,
"industry": 123
},
"total": 123,
"filteredTotal": 123,
"limit": 123,
"offset": 123,
"hasMore": true
}
}Visitor suppression
List suppression rules
Returns the organization’s suppression rules, newest first. Suppressed visitors are still identified, but they consume no credits and trigger no webhooks or integrations. Paginated: limit defaults to 500 and caps at 5000. counts and total always describe the whole list, not the returned page. Authenticates via X-API-Key header.
GET
/
v1
/
data
/
suppression-rules
List suppression rules
curl --request GET \
--url https://api.aws53.cloud/v1/data/suppression-rules \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.aws53.cloud/v1/data/suppression-rules"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.aws53.cloud/v1/data/suppression-rules', 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://api.aws53.cloud/v1/data/suppression-rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://api.aws53.cloud/v1/data/suppression-rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.aws53.cloud/v1/data/suppression-rules")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aws53.cloud/v1/data/suppression-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "email",
"value": "<string>",
"createdAt": "<string>"
}
],
"counts": {
"email": 123,
"domain": 123,
"company_domain": 123,
"industry": 123
},
"total": 123,
"filteredTotal": 123,
"limit": 123,
"offset": 123,
"hasMore": true
}
}Authorizations
Organization API key (sk_...). Get yours from Settings > API Keys in the dashboard.
Query Parameters
Return only rules of this type
Available options:
email, domain, company_domain, industry Required range:
1 <= x <= 5000Required range:
x >= 0Response
Suppression rules
Show child attributes
Show child attributes
Was this page helpful?