Skip to main content
List approval rules

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string[]

Return only these fields of each row; use dots for nested fields, such as approvers.user_id. id is always returned. Fields: id, name, subject, conditions, fallback, position, approvers, approver_teams, references, skipped_people, skipped_teams, created_at, updated_at.

limit
integer
default:50
Required range: 1 <= x <= 1000
cursor
string
Maximum string length: 4096
subject
enum<string>

Only rules for this subject.

Available options:
invoice,
purchase_order

Response

A page of approval rules.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required