Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Query Parameters

direction
enum<string>

Filter to one direction

Available options:
SEND,
RECEIVE
action
enum<string>

Filter to one action

Available options:
ALLOW,
BLOCK
agentId
string

Filter to the rules that BIND this agent — its own rules plus org-wide ones, i.e. exactly the set evaluated when it sends or receives. To list only org-wide rules, use scope=org instead.

Pattern: ^[cC][^\s-]{8,}$
scope
enum<string>

org = org-wide rules only; agent = agent-scoped rules only; all (default) = both. Combine with agentId to answer 'what binds this agent?'

Available options:
org,
agent,
all

Response

200 - application/json

OK

A list of email allow/block rules

rules
object[]
required

Matching rules, newest first

total
integer
required

Number of rules returned