Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Email

List the email rules of the workspace

The allow and block rules of every teammate's inbox in the workspace. They apply beside the rules of each inbox (GET /agents/{handle}/inbox): a block of either wins, and with an allow rule of either for a direction, only what an allow rule names goes through that way.

get/api/v1/email/rules

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy email-rules list
MCP tooltroopy_list_email_rules
Rate limit60 calls in 60 seconds, for each key

Response

200 · application/json
data*object
1 properties
rules*array<object>
4 properties
id*string

A 24-character id

kind*enum<string>

allowblock

value*string

An email address, or a domain with its subdomains

direction*enum<string>

in: mail that it gets. out: mail that it sends. both

inoutboth

Errors

401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.