Skip to main content
GET
Get workflow by ID

Authorizations

X-API-KEY
string
header
required

Path Parameters

workflow_id
integer
required

Response

OK

Schema for workflow output.

id
integer
required
record_type
enum<string>
required

Supported record types for workflows.

Available options:
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
name
string
required
is_active
boolean
required
description
string
required
version
integer
required
priority
integer
required
company_ids
integer[]
required
applies_to_all_companies
boolean
required
allow_self_approval
boolean
required
steps
PublicStepSchemaOut · object[]
required
pending_approval_count
integer
required
roles
Roles · object
required
Last modified on July 13, 2026