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": -86174406.09408069,
"y": -79809060.9701072
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -75604329.98207292,
"y": 14085831.005014747
}
},
"transitions": {},
"groups": [
"d26f88131a8c5c0d04118830",
"647b8daf5fd1ebc1eec4ce60",
"293848feb09bec7ad07e34e1"
],
"_id": "c36bfd96-3ee4-1ebe-4f02-cde2ed36b7e6",
"description": "ea et sint commodo",
"font_size": 12,
"created": "1968-07-14T19:25:39.469Z",
"created_by": "24210dff05864733713035ec",
"last_updated": "1981-01-02T00:26:19.246Z",
"last_updated_by": "01ea545f6481c9bba57960a2"
},
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": 91465312.74920467,
"y": -6337059.421805918
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 51222544.61474848,
"y": 97295627.56323394
}
},
"transitions": {},
"groups": [
"241b1b2e9b218678baab6003",
"267ec623266dd2db5fbe6f2a"
],
"_id": "1fc2bf64-8c72-ebc4-a42a-4d9989b8e1c4",
"description": "Excepteur in",
"font_size": 12,
"created": "1955-12-03T10:03:10.161Z",
"created_by": "47199a2af4fa59cac26fb9a2",
"last_updated": "2008-05-30T03:30:37.508Z",
"last_updated_by": "743292f7e9d499f3bf9ed7f9"
},
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": -56812868.70384707,
"y": -97928410.51702408
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": -76807839.08460511,
"y": -99214467.2914459
}
},
"transitions": {},
"groups": [
"0fc6c32f0474c738ed066885",
"98d80299fd4e0afd0ab0754d",
"b83941b7d4a013b55297eeb2",
"6a006775aede9605a239fe70",
"e0a2b9245b2062b77ecc48ef"
],
"_id": "61316bcb-74b7-6805-84b7-8e9bc8feadf4",
"description": "est sit reprehenderit elit",
"font_size": 12,
"created": "1994-03-07T23:29:04.495Z",
"created_by": "ae9f597cf9368e061f18f9fe",
"last_updated": "2007-12-13T11:03:17.051Z",
"last_updated_by": "6b2a209ff4280fa59be28710"
}
]
Copied to Clipboard
{
"title": "result",
"type": "array",
"items": {
"$ref": "workflowDocument"
}
}