Workflows
Get workflow info
The workflow itself: name, status (running or paused), sharing, folders, apps.
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*RegionsRegion of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them
"besg""usnv"OK
application/json- response
A workflow, as the documented "Get workflow info" answers it
workflow_id*Workflow Idworkflow_name*Workflow Nameworkflow_resource_id*Workflow Resource Idworkflow_status*WorkflowStatus"running""paused""deleted"workspace_id*Workspace Idis_shared_with_workspace*Is Shared With Workspacemodule_app_type_display_list?array<string>|nullparent_folders?array<>|nullcreated_by*Created Bycreated_time*Created Timelast_modified_by*Last Modified Bylast_modified_time*Last Modified Timecurl -X GET 'https://api.stacksync.com/v1/workspaces/0/workflows/id/497f6eca-6276-4993-bfeb-53cbbbba6f08/info?region=besg'{ "workflow_id": "<workflow_id>", "workflow_name": "<workflow_name>", "workflow_resource_id": "<workflow_resource_id>", "workflow_status": "running", "workspace_id": 0, "is_shared_with_workspace": false, "module_app_type_display_list": [ "<module_app_type_display_list>" ], "parent_folders": [ { "parent_folder_id": "3f6c1d2e-8a4b-4c7d-9e21-5b6f7a8c9d01", "type": "primary" } ], "created_by": 0, "created_time": "<created_time>", "last_modified_by": 0, "last_modified_time": "<last_modified_time>"}GETGet workflow
A version of a workflow (the latest when no version is given) with its document, and the workflow's region.
POSTCreate workflow
Create a workflow with only its Input step, as the builder's New workflow does: its other steps are saved in its draft once it exists (PATCH /draft), which sets up their triggers. A document refused leaves no workflow behind.