Skip to main content
GET
Get a rule
Returns a rule you authored, expression included. A managed rule’s identifier answers 404 rather than 403. You don’t own the identifier, and confirming that it exists would confirm one you were never shown. Managed rules are served, without their expressions, by List managed rules.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

rule_id
string
required

The rule identifier.

Example:

"rul_01jc0t6fwwfgfsq1md24mhyztj"

Response

OK

id
string
required

The rule identifier. Reference it in a recipe's rules to score over it.

Example:

"rul_01jc0t6fwwfgfsq1md24mhyztj"

name
string
required
Example:

"free_plan_signup"

expression
string
required
Example:

"attr.plan_tier == \"free\""

type
enum<string>
required

Always CUSTOM. A rule you author is your own; Prelude's are a separate, read-only listing.

Available options:
CUSTOM