Summary
Get Filtered Workflows
Description
Get all Workflow names and IDs based on specified filters.
Route
POST /workflow_builder/workflows/filtered
Roles
admin
engineering
support
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
options |
object |
yes |
Filters for Workflows. |
Copied to Clipboard
{
"options": {
"start": 0,
"limit": 25,
"filter": {},
"sort": {
"name": 1
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"title": "options",
"type": "object",
"properties": {
"start": {
"type": "integer",
"default": 0
},
"limit": {
"type": "integer",
"default": 25
},
"filter": {
"type": "object"
},
"sort": {
"type": "object",
"default": {
"name": 1
}
}
},
"required": []
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
array |
List of all Workflows. |
Copied to Clipboard
[
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": 38783292.8110078,
"y": 61345368.95115605
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -47184622.79497526,
"y": -81960298.25292079
}
},
"transitions": {
"workflow_start": {},
"workflow_end": {}
},
"groups": [
"d3644c47d1d357d51d71a993",
"2ef6275b290220fdcfe515cd"
]
},
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": -17689938.385774747,
"y": -87543973.3380472
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -2731094.7648574263,
"y": 42957150.84908259
}
},
"transitions": {
"workflow_start": {},
"workflow_end": {}
},
"groups": [
"8afec7be6fbbb95eb5eac19c",
"a983db79020f9db0ebe60cc4",
"4b0c848b8eb65007a117ccb8"
]
},
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": 41913917.9630537,
"y": 8110120.093674883
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 90142126.216795,
"y": -7173812.1283956915
}
},
"transitions": {
"workflow_start": {},
"workflow_end": {}
},
"groups": [
"07c37ac13e5543d301be23b3",
"6862929c9ae9073587ef5084",
"b19a26aa46dcd961d04f17da"
]
},
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": -43498703.46665465,
"y": 33448713.157890216
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 90446748.38322723,
"y": 75131951.41487369
}
},
"transitions": {
"workflow_start": {},
"workflow_end": {}
},
"groups": [
"91976d356690858f5ad7a2ee",
"9caaaeff2e83fdaec67f29c2",
"291b3e37c07dbcf84d540f39"
]
},
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": 14216179.178755313,
"y": 43873174.37358731
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 10417069.016738221,
"y": 42573926.473956585
}
},
"transitions": {
"workflow_start": {},
"workflow_end": {}
},
"groups": [
"ec9093971b776f3be1eb2623",
"31ade7a403aff192afcd4865"
]
}
]
Copied to Clipboard
{
"title": "result",
"type": "array",
"items": {
"$ref": "workflowDocument"
}
}