Skip to main content

List Support Rules

GET 
/api/support/admin/rules

Lists every automation rule — active and inactive, built-in and custom — in run order (position, then id). Not paginated; no filters.

Required scope: support:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Response fields: id (integer), name (string), trigger (string — one of: ticket_created, ticket_updated, customer_replied, agent_replied, hourly), trigger_label (string), conditions[] (object[] — field, operator, value), actions[] (object[] — type, value), position (integer — run order within the trigger, lowest first), is_active (boolean), is_system (boolean — built-in rules that can be edited or switched off but not deleted), created_at / updated_at (ISO-8601).

How rules run: a trigger fires when the corresponding event happens — ticket_created, ticket_updated, customer_replied and agent_replied run immediately at the end of the action that caused them; hourly runs from a scheduled sweep over every ticket that is not closed. For a trigger, every active rule runs in position order (ties broken by id); there is no stop-processing flag, so every rule whose conditions match runs. A rule matches when ALL of its conditions hold (an empty condition list always matches). Its actions then run in order; each action that changes something is recorded in the ticket's event history with the actor Rule: <name>, plus one rule_applied event per rule that had an effect. Actions never fire triggers themselves, so rules cannot cascade into one another. An hourly rule fires at most once per ticket per status epoch: it is skipped while its last rule_applied event is newer than the ticket's last status change.

Authentication: Bearer token with the support:read scope, or an authenticated session, from a caller with an active support role who also holds the support admin role. No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type