List rules
Individual rules
List rules
List rules for your organization. With sort_by=order (the default), results follow rule-set order and then local rule order. Use rule_set_id to return rules from one containing set.
GET
List rules
Returns all rules in your organization. Pass
program_id to scope results to a single program, and pass rule_set_id to return rules from one set. Archived rules are excluded by default; pass include_archived=true or filter by status to control which rules are returned. Use search to find rules by name.
Each rule includes rule_set_id. With the default sort_by=order, rules are grouped by rule-set position and then by their local position. Use sort_by and sort_dir to select another ordering.
For usage patterns and examples, see the Writing Rules guide.
Authorizations
API key passed in the X-API-Key header.
Query Parameters
Maximum number of results (default 50, max 200)
Required range:
x >= 1Pagination cursor from previous response
Filter by program ID
Filter by containing rule set ID
Include archived rules
Filter by rule status
Available options:
ACTIVE, SUSPENDED, ARCHIVED Search by rule name (partial match)
Sort field
Available options:
order, created_at, name Sort direction
Available options:
asc, desc