Workflow instances
Individual runs of a workflow: what each one did, where it got to, and what it is waiting on.
List instances
Every run of every workflow in the workspace, newest first. Filter to one workflow with wi_workflow, or to a period with wi_created.
query Parameters
cursor^[A-Za-z0-9_-]+$limitoffsetsort^-?[a-z0-9_]+$wi_createdwi_idwi_initiated_bywi_statuswi_updatedwi_workflowHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List instances › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Get an instance
Where the run has reached, step by step. Every step the workflow defines is listed — the ones that have not run yet carry a pending status — along with any task it is waiting on.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get an instance › Responses
Success
wi_idwi_workflowwi_statuswi_providerwi_provider_idwi_statewi_errorwi_initiated_bywi_createdwi_updatedwf_nameName of the workflow this instance runs.
Refresh an instance
Asks the execution engine what this run is doing and stores the answer. Status normally arrives on its own when the run finishes; this is for a run that looks stuck.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Refresh an instance › Responses
Success