List shield rules
curl --request GET \
--url https://inboundr.net/api/v1/shield-rules \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://inboundr.net/api/v1/shield-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://inboundr.net/api/v1/shield-rules"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://inboundr.net/api/v1/shield-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 => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": [
{
"id": "gr_123",
"name": "Always let the CEO through",
"action": "allow",
"priority": 0,
"enabled": true,
"scope": "account",
"domainId": null,
"addressId": null,
"conditions": [
{ "field": "from", "operator": "equals", "value": "ceo@partner.com" }
],
"endpointIds": [],
"createdAt": "2026-07-20T10:00:00.000Z"
},
{
"id": "gr_456",
"name": "Drop flagged spam",
"action": "block",
"priority": 1,
"enabled": true,
"scope": "domain",
"domainId": "dom_123",
"addressId": null,
"conditions": [
{ "field": "spam_verdict", "operator": "equals", "value": "FAIL" }
],
"endpointIds": [],
"createdAt": "2026-07-20T10:01:00.000Z"
}
]
}
Shield Rules
List shield rules
Your rules, in the order they are evaluated.
GET
/
api
/
v1
/
shield-rules
List shield rules
curl --request GET \
--url https://inboundr.net/api/v1/shield-rules \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://inboundr.net/api/v1/shield-rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://inboundr.net/api/v1/shield-rules"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://inboundr.net/api/v1/shield-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 => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": [
{
"id": "gr_123",
"name": "Always let the CEO through",
"action": "allow",
"priority": 0,
"enabled": true,
"scope": "account",
"domainId": null,
"addressId": null,
"conditions": [
{ "field": "from", "operator": "equals", "value": "ceo@partner.com" }
],
"endpointIds": [],
"createdAt": "2026-07-20T10:00:00.000Z"
},
{
"id": "gr_456",
"name": "Drop flagged spam",
"action": "block",
"priority": 1,
"enabled": true,
"scope": "domain",
"domainId": "dom_123",
"addressId": null,
"conditions": [
{ "field": "spam_verdict", "operator": "equals", "value": "FAIL" }
],
"endpointIds": [],
"createdAt": "2026-07-20T10:01:00.000Z"
}
]
}
Returns every shield rule on the account, ordered by
priority (lowest first).
The order is the meaning of the list: the first rule whose conditions all
match a message wins, and no later rule is consulted. Do not re-sort the
response — a client that displays these alphabetically is showing something
other than what will happen to the mail.
{
"data": [
{
"id": "gr_123",
"name": "Always let the CEO through",
"action": "allow",
"priority": 0,
"enabled": true,
"scope": "account",
"domainId": null,
"addressId": null,
"conditions": [
{ "field": "from", "operator": "equals", "value": "ceo@partner.com" }
],
"endpointIds": [],
"createdAt": "2026-07-20T10:00:00.000Z"
},
{
"id": "gr_456",
"name": "Drop flagged spam",
"action": "block",
"priority": 1,
"enabled": true,
"scope": "domain",
"domainId": "dom_123",
"addressId": null,
"conditions": [
{ "field": "spam_verdict", "operator": "equals", "value": "FAIL" }
],
"endpointIds": [],
"createdAt": "2026-07-20T10:01:00.000Z"
}
]
}
⌘I