Shield rules

List shield rules

Your rules, in the order they are evaluated.

GET/api/v1/shield-rules

cURL

curl -X GET "https://inboundr.net/api/v1/shield-rules" \
  -H "Authorization: Bearer $INBOUNDR_API_KEY"

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 checked. Don't re-sort the response: a client that shows these alphabetically would misrepresent what will happen to the mail.

Example response

200

{
  "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"
    }
  ]
}