Skip to main content
GET
List an organization's business policies
Business policies decide what happens to the organization’s payments and reviewed transactions: each one has conditions and the actions taken when they match — approve, deny, or open an approval request. Within a context, active policies are tried by ascending order and the first match decides. Archived policies are left out unless you ask for them with status=ARCHIVED. Filter by context, status, autoAction and moveBalance, search names and descriptions with query, and page with limit + next. A blank parameter counts as not sent, and an unknown one is ignored. Each approver in actions.approvals carries the user’s or group’s current name; it is left out when the approver can no longer be found. Any member of the organization can list its policies.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose policies you want to list.

Format: UUID

Query Parameters

context
enum<string>

Only policies of this context.

Available options:
PAYMENT,
SPEND_REVIEW,
TRAVEL
status
enum<string>

Only policies in this status. Omitted, the list holds ACTIVE and DISABLED policies; send ARCHIVED to list the archived ones.

Available options:
ACTIVE,
DISABLED,
ARCHIVED
query
string

Only policies whose name or description contains this text (case-insensitive).

Required string length: 1 - 120
autoAction
enum<string>

Only policies with this actions.autoAction. NONE lists the policies that open an approval request.

Available options:
APPROVE,
DENY,
NONE
moveBalance
enum<string>

true: only policies that fund the payment from another wallet (actions.moveBalance.addBalance). false: only those that don't, including policies without moveBalance.

Available options:
true,
false
sort
enum<string>

Field to sort by. Defaults to order, the evaluation order, so the list reads in the order policies are tried.

Available options:
order,
name,
createdAt
direction
enum<string>

Sort direction. Defaults to asc.

Available options:
asc,
desc
next
string

Cursor returned as next by the previous page. Omit for the first page.

limit
integer

Page size. Defaults to 20.

Required range: 1 <= x <= 100

Response

Successful response

A page of the organization's business policies.

next
string | null
required

Cursor for the next page — send it as next. null on the last page.

Example:

"NjcyMGYzYTFjOWU3N2IwMDEyYTRkNmY5"

items
object[]
required

The policies of this page, in the requested order.