get_automation_ruleset
Updated May 21, 20261 min read
Get a single automation ruleset by ID. Returns ruleset metadata — name, entity type, merchant and country scope, and status.
Does not include the individual rules inside the ruleset — for
those use
list_automation_rules.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | The tenant. |
ruleset_id | string | Yes | The automation ruleset id. |
Returns
A single ruleset object — id, name, entity type (FORWARD /
REVERSE), merchant + country scope, status (active / disabled).
Example agent prompts
"What's the scope of ruleset RS-001?"
get_automation_ruleset(
tenantId="…",
ruleset_id="RS-001"
)
The agent narrates: "RS-001 is the Acme forward ruleset for KSA — currently active."
Related tools
list_automation_rulesets— find ruleset ids when you don't know which one to fetch.list_automation_rules— the actual rules inside this ruleset.
Notes
- This tool is cheap — small payload, no rule evaluation. Safe to call as part of any explanation flow.