Skip to main content
All endpoints are nested under a specific contract: /contracts/:id/workflow/*.
EndpointBodyRequiresNotes
POST /contracts/:id/workflow/transition{ note?, transitionCode?, toStageCode? }contract_edit (edit)Requires the tenant’s workflowAutomation feature flag. Advances the contract along a configured lifecycle transition, or directly to toStageCode.
POST /contracts/:id/workflow/lock{ locked?: boolean, note? }admin (edit)Requires workflowAutomation. A locked contract blocks core-field edits until unlocked by a role with sufficient workflow control.
GET /contracts/:id/workflow/events—contract_view (view)Full stage/lock event trail for the contract.
See Roles & Permissions for how workflow control levels (none / view / edit / approve / sign / admin) gate transitions separately from module permissions, and Contract Workspace for the product-level view.