get/email-rules

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/email-rules
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

direction'SEND' | 'RECEIVE'

Filter to one direction

action'ALLOW' | 'BLOCK'

Filter to one action

agentIdstring

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.

scope'org' | 'agent' | 'all'

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

Response

OK

totalinteger required

Number of rules returned

Changes

No recorded changes to this operation across all 1 revision of this API.