Workflows
List 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.
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.
region?|Region to filter workflows by. If not provided, all regions will be included.
nulloffset?|Offset for pagination. Used to skip a number of workflows.
0limit?LimitMaximum number of workflows of each region, at most 200
1 <= value <= 20020folder_id?|Only the workflows directly in this folder
nullsearch?|Only the workflows whose name, id or resource id contains this text
nullOK
application/json- response
The documented list answer, one page of each region asked for
workflows*array<>curl -X GET 'https://api.stacksync.com/v1/workspaces/0/workflows/'{ "workflows": [ { "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>", "region": "besg" } ]}POSTGenerate an app schema
Read the tables of a connection and the columns of the tables named, so a sync can be built from exact table and column names. The credentials are read from the connection, never sent. Readable with a read-only key.
GETList workflow versions
Every version of a workflow, newest first, as a JSON array; minimized=true leaves each version's document and options out.