Workflows API
20 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.
| Method | Path | Description |
|---|---|---|
GET |
/api/workflows/ |
List Workflows Query: is_active, trigger_type. |
POST |
/api/workflows/ |
Create Workflow Accepts a JSON body. |
GET |
/api/workflows/by-account/{account_id}/overrides |
Overrides For Account |
GET |
/api/workflows/field-metadata |
Get Field Metadata |
GET |
/api/workflows/runs/recent |
List Recent Runs Query: status, limit. |
GET |
/api/workflows/runs/{run_id} |
Get Workflow Run |
POST |
/api/workflows/runs/{run_id}/approve |
Approve Run |
POST |
/api/workflows/runs/{run_id}/reject |
Reject Run Accepts a JSON body. |
GET |
/api/workflows/templates |
List Templates |
GET |
/api/workflows/{workflow_id} |
Get Workflow |
PUT |
/api/workflows/{workflow_id} |
Update Workflow Accepts a JSON body. |
DELETE |
/api/workflows/{workflow_id} |
Delete Workflow |
POST |
/api/workflows/{workflow_id}/activate |
Activate Workflow |
POST |
/api/workflows/{workflow_id}/deactivate |
Deactivate Workflow |
GET |
/api/workflows/{workflow_id}/overridable |
List Overridable |
GET |
/api/workflows/{workflow_id}/overrides |
List Overrides Query: account_id. |
PUT |
/api/workflows/{workflow_id}/overrides |
Upsert Override Accepts a JSON body. |
DELETE |
/api/workflows/{workflow_id}/overrides |
Delete Override Query: account_id, step_id, field. |
GET |
/api/workflows/{workflow_id}/runs |
List Workflow Runs Query: status, limit, offset. |
POST |
/api/workflows/{workflow_id}/test |
Test Workflow Accepts a JSON body. |
Try it
The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.