Workflows
List workflow versions
Every version of a workflow, newest first, as a JSON array; minimized=true leaves each version's document and options out.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
workflow_id*stringThe workflow.
uuidregion?|Data region of the resources: besg (Europe) or usnv (United States), as GET /v1/regions lists them.
nullminimized?|true to leave each version's document and options out
nullOK
application/json- response
The documented versions answer: a JSON array, newest first
[index: integer]?A version of a workflow, as the documented "Get workflow" answers it; workflow_schema is the workflow document
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/workflows/id/497f6eca-6276-4993-bfeb-53cbbbba6f08/versions'[ { "workflow_id": "<workflow_id>", "workflow_version": "<workflow_version>", "workflow_status": "<workflow_status>", "is_draft": false, "is_deployed": false, "workflow_schema": { "workflow_execution_timeout": 300, "workflow_module_execution_timeout": 300, "return_workflow_module_instance_ids": [ "<return_workflow_module_instance_ids>" ], "modules": [ { "name": "<name>", "workflow_module_instance_id": "<workflow_module_instance_id>", "module_id": "<module_id>", "description": "<description>", "properties": {}, "connections": [], "module_options": { "patches": {}, "layout": { "group_module_instance_id": "<group_module_instance_id>" }, "enable_error_handling": false, "workflow_module_execution_timeout": 0 }, "error_handling_strategy": { "conditions": [], "else_condition": { "retry_count": 0, "retry_interval": 0 } } } ], "edges": [ { "source": { "handle_id": "<handle_id>", "workflow_module_instance_id": "<workflow_module_instance_id>" }, "target": { "handle_id": "<handle_id>", "workflow_module_instance_id": "<workflow_module_instance_id>" }, "edge_id": "<edge_id>" } ] }, "options": {}, "created_by": 0, "created_time": "<created_time>", "last_modified_by": 0, "last_modified_time": "<last_modified_time>" }]GETList workflows
The workflows of the workspace the caller sees on the web app's Resources page (their own and those shared with the workspace), newest first, one page per region (or of the region asked for). Optionally only the workflows directly in a folder, or those whose name or id contains a text.
GETGet workflow
A version of a workflow (the latest when no version is given) with its document, and the workflow's region.