Skip to main content
GET
Get a rule, archived or not

Authorizations

Authorization
string
header
required

A workspace token in the Bearer scheme. The workspace must have the Connect app enabled.

Path Parameters

number
integer
required

The rule's number

Required range: x >= 1

Response

The rule

number
integer

Identifies the rule in its workspace for good: numbers are never reused. Profiles list rules by number.

id
string
text
string
addon
string

The GOBL addon the rule names, if any

profiles
string[]

Ids of the profiles using the rule

created_at
string<date-time>
updated_at
string<date-time>
archived_at
string<date-time>

Set on an archived rule