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": 9360452.667780012,
"y": -37965766.7700108
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -60685916.188677825,
"y": 34385604.5828861
}
},
"transitions": {},
"groups": [
"65fefde3c04b399a8101e796"
],
"_id": "e08b31a2-17b8-bac0-b0be-1af73790b232",
"description": null,
"font_size": 12,
"created": "1955-03-21T18:05:40.69Z",
"created_by": "fea351238685519949bf8275",
"createdVersion": "ad",
"last_updated": "1957-11-24T05:09:09.943Z",
"last_updated_by": "0e903a460ee6ac3c5e05c56e",
"lastUpdatedVersion": "tempor qui eu sed velit",
"tags": []
}
]
Copied to Clipboard
{
"title": "result",
"type": "array",
"items": {
"$ref": "workflowDocument"
}
}