Skip to main content
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

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

program_id
string<uuid>

Filter by program ID

rule_set_id
string<uuid>

Filter by containing rule set ID

include_archived
boolean
default:false

Include archived rules

status
enum<string>

Filter by rule status

Available options:
ACTIVE,
SUSPENDED,
ARCHIVED

Search by rule name (partial match)

sort_by
enum<string>

Sort field

Available options:
order,
created_at,
name
sort_dir
enum<string>

Sort direction

Available options:
asc,
desc

Response

List of rules

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results