Skip to main content
GET
Get the Approvals Workflow configuration
Retrieve the full Approvals Workflow configuration for a specific client. This includes both the approval rules and the groups involved in the workflow.

Authorizations

x-api-key
string
header
required

An API Key.

Headers

Authorization
string
required

The access token

X-Contact-ID
string

The ID of the contact

Query Parameters

client_id
string
required

The ID of the client

Response

Client Approvals Workflow configuration

The configuration of the Approvals Workflow for a client.

groups
object[]
required

The groups (payment and admin) configured for the client.

ruleset
object
required

The payment approval ruleset for the client.