Get approval workflow
Retrieve a single approval workflow.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Approval workflow ID.
"apw_DKL4Xcb5VSa8CQ"
Approval workflow name.
"Enterprise quote approval"
Approval workflow description.
"Requires approval for high-value subscription quotes."
Quote, subscription, invoice, or credit-note flows where the workflow applies. workflow_step workflows are picked by a workflow's Request approval step, apply to no other flow, have no rules, and can't be created or updated through the API.
quote_subscription, quote_subscription_update, quote_one_off, subscription_update, invoice, credit_note, workflow_step Whether the workflow is active.
true
Workflow priority. Lower values are evaluated first when multiple workflows match.
10
Rules that determine when the workflow applies. Empty for workflow_step workflows.
How workflow steps execute. Sequential steps run by order; parallel steps run together.
sequential, parallel "sequential"
Whether approvers receive email notifications for this workflow.
true
Approval steps required by the workflow.
Workflow version number.
1
Original workflow ID when this workflow is an archived version.
null

