Processes API
Listing processes, retrieving process definitions, and creating records (submissions) via API.
Overview
The Processes API lets you list, retrieve, and inspect process definitions programmatically. This is useful for building internal tooling, syncing process metadata to external systems, or validating that production processes match your configuration-as-code.
List Processes
- GET
/v1/processes— returns a paginated list of all processes in the workspace. - Query parameters:
status(draft | published | archived),page,per_page(max 100).
Get a Process
- GET
/v1/processes/{process_id}— returns the full process definition including stages, form schema, and routing rules.
Create a Record (Submit a Process)
- POST
/v1/processes/{process_id}/records— creates a new record (submission) for the given process. - Request body: a JSON object where keys are field variable names and values are the field values.