Sign in
Approval Policies

Get workflow by ID

Retrieve a single approval workflow by its ID, including all steps, conditions, and approvers.

get/public/v2/workflows/{workflow_id}/

Path parameters

workflow_idinteger required

Response

OK

idinteger required
record_type'invoice' | 'bill' | 'journal_entry' | 'bank_transfer' | 'purchase_order' | 'sales_order' | 'intercompany_journal_entry' | 'contract' | 'customer_credit' | 'direct_expense' | 'cash_sale' | 'customer_prepayment' | 'customer_deposit' | 'customer_payment' | 'customer_refund' | 'vendor_prepayment_application' | 'customer_prepayment_application' | 'vendor_payment' | 'vendor_credit' | 'vendor_refund' | 'vendor_prepayment' | 'vendor' | 'customer' required

Supported record types for workflows.

namestring required
is_activeboolean required
descriptionstring required
versioninteger required
priorityinteger required
company_idsinteger[] required
applies_to_all_companiesboolean required
allow_self_approvalboolean required
pending_approval_countinteger required
rolesobject required

Changes