Skip to main content
GET
Get the Approvals Workflow settings
Retrieve the Approvals Workflow settings for a specific client. This includes whether the workflow is enabled and whether the “creator as approver” option is active.

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 settings

The Approvals Workflow settings for a client.

payment_approvals_enabled
boolean
required

Whether the Approvals Workflow is enabled for payments.

payment_creator_approval_enabled
boolean
required

Whether the creator of a payment can act as an approver.