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,
"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": 95885616.6665059,
"y": -85140223.34792419
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 82140474.63495836,
"y": -69576965.79177317
}
},
"transitions": {},
"groups": [
"a70b5e6e89215497c52568bb"
],
"_id": "45ec7f52-a6af-8581-36d3-5ac7adc5ef17",
"description": null,
"font_size": 12,
"created": "2004-04-26T20:18:19.095Z",
"created_by": "f0fce6ed700b6a11d0f97be6",
"last_updated": "1988-08-14T16:35:16.003Z",
"last_updated_by": "830e839f593c01740ac736c7"
}
]
Copied to Clipboard
{
"title": "result",
"type": "array",
"items": {
"$ref": "workflowDocument"
}
}