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": 93926043.1849846,
"y": -71779562.8133385
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -60762333.80102445,
"y": 24521695.25992538
}
},
"transitions": {},
"groups": [
"17bceee4cde54e230a3b376b",
"daec057a4fc376e148740206",
"3356929a3f1e7956312c96a5"
],
"_id": "562c2abb-7c88-30e5-d007-04e21366cd87",
"description": null,
"font_size": 12,
"created": "1972-10-22T19:50:01.608Z",
"created_by": "66d0439de1293020203ebffa",
"createdVersion": "reprehenderit irure labore",
"last_updated": "1992-07-06T02:09:17.163Z",
"last_updated_by": "59dfefce54ad3f84356bacb1",
"lastUpdatedVersion": "in reprehenderit est officia incididunt",
"tags": []
}
]
Copied to Clipboard
{
"title": "result",
"type": "array",
"items": {
"$ref": "workflowDocument"
}
}
