Summary
Gets a page of workflow documents.
Description
Gets a page of workflow documents.
Route
GET /automation-studio/workflows
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
options | object | yes | Parameters for filtering, paginating, and sorting workflow documents. For ‘limit’, ‘skip’, ‘order’, ‘sort’, ‘include’, ‘exclude’, and ‘expand’: Example usage in getWorkflows task -- ‘{ ‘limit’: 10 }’ Example usage in HTTP query -- ‘?limit=10' For ‘in’, ‘not-in’, ‘equals’, ‘contains’, ‘starts-with’, ‘ends-with’, and ‘task-equals’: Example usage in getWorkflows task -- ‘{ ‘in’: { ‘name’: ‘my-workflow’ } }’ Example usage in HTTP query -- ‘?in[name]=my-workflow' |
{ "options": { "limit": 1, "skip": 50, "order": 1, "sort": "name", "exclude-project-members": true, "include": "name,description", "exclude": "description", "expand": "created_by,user,owner", "in": "in[name]=my-workflow,or-this-workflow&in[type]=automation", "not-in": "not-in[name]=my-workflow,not-this-workflow", "equals": "equals[name]=my-workflow", "contains": "contains[name]=workflow", "starts-with": "starts-with[name]=my-", "ends-with": "ends-with[name]=-workflow", "task-equals": "task-equals[app]=WorkFlowEngine" } }
{ "type": "object", "properties": { "options": { "title": "options", "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of results to return. Used for pagination.", "default": 25, "minimum": 0, "examples": [ 1, 10, 50 ] }, "skip": { "type": "integer", "description": "Number of results to skip. Used for pagination.", "default": 0, "minimum": 0, "examples": [ 1, 10, 50 ] }, "order": { "type": "integer", "description": "Sort direction, 1 for ascending and -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by", "default": "name", "enum": [ "name" ] }, "exclude-project-members": { "type": "boolean", "description": "Flag which removes workflows from the results which are members of a project" }, "include": { "type": "string", "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", "examples": [ "name", "description", "name,description" ] }, "exclude": { "type": "string", "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", "examples": [ "_id", "description", "_id,description" ] }, "expand": { "type": "string", "title": "List of fields to get expanded data", "description": "Sets the fields to expand. Generally, these are fields like \"metrics.user\", \"metrics.owner\", \"created_by\", etc", "examples": [ "created_by,user,owner" ] }, "in": { "description": "Search for fields exactly matching one of the given list options", "type": "string", "examples": [ "in[name]=my-workflow,or-this-workflow&in[type]=automation" ] }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "type": "string", "examples": [ "not-in[name]=my-workflow,not-this-workflow" ] }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "type": "string", "examples": [ "equals[name]=my-workflow" ] }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string", "examples": [ "contains[name]=workflow" ] }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string", "examples": [ "starts-with[name]=my-" ] }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string", "examples": [ "ends-with[name]=-workflow" ] }, "task-equals": { "description": "Returns results where one or more tasks have fields that exactly match the given match string(s).", "type": "string", "examples": [ "task-equals[app]=WorkFlowEngine" ] } } } }, "required": [ "options" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | Results for the given search parameters. |
{ "items": [ { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "1ddd0aca446bddb260e9d5e1", "5c5c5de7f740dd324a646914" ], "nodeLocation": { "x": 22744679.035870075, "y": 39933899.38305393 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "09fa15acf846930a854c7315", "76b41bd3e4ef3ea9bb1f4db3" ], "nodeLocation": { "x": 83304850.05554947, "y": 28596364.958157852 } }, "error_handler": { "name": "childJob", "summary": "amet Excepteur nulla", "description": "sed anim", "app": "minim dolor Duis ad tempor", "variables": { "error": "" }, "groups": [ "abde4f3303c16f452236eb42", "a6cc5cd90eff14c158ed523a" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "failure", "error", "error", "error" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "85fbdeefcf29ee9f743a2ecb", "bc6ed204d837be0db02a312d" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "laborum consequat Lorem eu", "accessControl": { "read": [ "minim nulla", "tempor", "ex aliquip amet" ], "write": [ "proident ipsum id dolor Ut", "et dolor Ut", "nostrud exercitation", "in", "non cupidatat" ], "execute": [ "voluptate eiusmod labore", "ad" ], "manage": [ "exercitation occaecat qui incididunt" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1954-10-19T09:31:29.523Z", "created_by": "91d70be8aca39444450f8241", "last_updated": "1993-02-20T21:40:01.526Z", "last_updated_by": "54bc6e9a240f2487834361cc", "lastUpdatedVersion": "est dolore ea nulla sint", "tags": [ "exercitation", "elit adipisicing ullamco", "culpa fugiat sint occaecat" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "eb2a789f633f4f2f2b308273" ], "nodeLocation": { "x": 77064867.40069857, "y": -8744289.74107863 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "70384e309486301910452dee" ], "nodeLocation": { "x": 86668101.47548243, "y": -63346352.76173226 } }, "error_handler": { "name": "childJob", "summary": "id ea ullamco culpa ad", "description": "tempor dolor adipisicing", "app": "Ut eu", "variables": { "error": "" }, "groups": [ "3c6fdf00cfd451938263a94e", "557fa08b236bc10edba0858d", "5023c41b58043a4c0b998af8", "b18eb7af4c37b0efb1057f8e" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "success", "error", "success", "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "a09385ae749761606503d679", "5810433d2dd445fa5fac664e", "bdaf641e4d9f731e178076ac", "c8724a6c59022aad93e29252" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "Lorem velit", "accessControl": { "read": [ "cupidatat tempor deserunt velit dolor", "consequat aliqua cillum mollit ullamco", "ipsum officia consectetur", "eu consequat ut dolore laborum" ], "write": [ "non", "labore sunt dolor", "Ut deserunt velit" ], "execute": [ "qui Excepteur", "amet ut", "nostrud ea mollit", "ut sint", "sit minim ipsum enim" ], "manage": [ "ut laboris", "aliqua ea anim cillum amet", "aliquip" ] } }, "description": "incididunt", "preAutomationTime": 5000, "font_size": 12, "created": "2025-01-08T05:02:43.268Z", "created_by": "17ea2ad78b02b1393a4f0869", "last_updated": "1984-11-17T13:02:31.428Z", "last_updated_by": "63cc8ffd0fbf51571cbf6430", "lastUpdatedVersion": "anim nulla in", "tags": [ "officia adipisicing eiusmod nulla", "sit proident eiusmod elit cillum", "nostrud occaecat dolore sed eu" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "8ac1f3d74cf8815c83a01b3f" ], "nodeLocation": { "x": -13389766.019465327, "y": -62353205.7515515 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "89f292d3210313a7ddee7973", "7fa54cf93a45d17c2c0be858", "d93a49ebd11ad36862f76653", "b8d8534bbbd76eadb8fa1734" ], "nodeLocation": { "x": -29238637.54933627, "y": 90871405.17423716 } }, "error_handler": { "name": "childJob", "summary": "voluptate sint aliqua mollit", "description": "laboris velit non", "app": "dolor quis et dolor", "variables": { "error": "" }, "groups": [ "8bbad8c163c0853d0dece976", "65b1d2057f2644cfeb173de5" ], "type": "operation", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "success", "error" ], "autoRetry": true, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "41968ffda664b977fe2cd095", "aa271d108368b899ea87e764", "492d36b6544c5e2cdbd39058", "c9824af75ea4b7445ce52173" ], "canvasVersion": 3, "_id": "4321abcdef694aa79dae47ad", "namespace": { "type": "project", "name": "nostrud aliquip esse aliqua laborum", "accessControl": { "read": [ "laborum" ], "write": [ "deserunt do qui", "adipisicing nostrud" ], "execute": [ "cupidatat enim reprehenderit", "amet dolor", "officia reprehenderit et eu fugiat", "magna et eu qui", "aute" ], "manage": [ "non laborum adipisicing pariatur officia", "exercitation anim aute", "sint aliquip", "elit cillum dolor consequat", "ex" ] } }, "description": "veniam adipisicing ut", "preAutomationTime": 5000, "font_size": 12, "created": "1975-09-05T20:06:03.614Z", "created_by": "e1b9f9f6561a19a6f88f14c9", "last_updated": "1948-10-31T22:23:30.756Z", "last_updated_by": "a5a59d86ace876d31f82a901", "lastUpdatedVersion": "ipsum anim cillum", "tags": [ "in nisi" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "c4b09bbef66fae252f597f45", "50f3a531e50012a7b2061d0d", "f6f43233d546d6b050d999b9" ], "nodeLocation": { "x": 16665056.822928876, "y": -33789842.311771914 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "0333408b70b8bdb79c9a871d", "0aa2d3ca1d5b589712d7ba5d", "7c9ec60deb0a311db23818f0", "f1aeb41d1152d326c2824dd7", "6a4c9956dddf18ca1ae48981" ], "nodeLocation": { "x": 3631064.9417242557, "y": 92013973.25191754 } }, "error_handler": { "name": "childJob", "summary": "velit exercitation ad ipsum ea", "description": "in ea non", "app": "voluptate esse laboris amet do", "variables": { "error": "" }, "groups": [ "62d530e5b2f7cd4b54d32660", "7996c80d7973f5425792f389", "bc16354061fd5075da97a9ec", "10437dc83b927251ae830843", "9944e605886d9b9bc550293d" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success" ], "autoRetry": true, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "f38aa87da34d21abf0436528" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "in adipisicing labore", "accessControl": { "read": [ "elit", "ut irure", "cillum enim", "eiusmod elit in voluptate" ], "write": [ "mollit ipsum", "Duis", "nostrud mollit ipsum sint dolore", "in" ], "execute": [ "dolor nulla eiusmod", "minim esse sint", "in dolore", "velit aliquip Lorem", "adipisicing" ], "manage": [ "consequat" ] } }, "description": null, "preAutomationTime": 5000, "font_size": 12, "created": "1976-05-23T00:05:55.833Z", "created_by": "64d02a5b4ea38a8a507d5787", "last_updated": "1980-01-06T09:02:34.316Z", "last_updated_by": "d5716939108a2496744d2a8a", "lastUpdatedVersion": "Ut", "tags": [ "dolor" ], "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "34e65f56c18cc8739c3d8f1e", "cad6f23a29bdd8e9326e1a31", "96f1d42f5f32b66770006d82", "2eccbad847fa68b6f6b16b74", "95426769239954f9118e2534" ], "nodeLocation": { "x": 81901768.0514468, "y": -33797591.268127516 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "0bcc9315b49e6a7b7fa1196c", "0fd5903d027a37c34433af7e", "639f31efbaa33b4f7f0e1f2d", "4ecb2ba38c30869505aea1d5" ], "nodeLocation": { "x": 6270044.419777364, "y": 26575816.26634617 } }, "error_handler": { "name": "childJob", "summary": "consectetur", "description": "ipsum", "app": "incididunt dolor", "variables": { "error": "" }, "groups": [ "27dceea166c7805edd9f961b", "dcc130b3285c49b3c5172e01", "d692d873edb624e2d1bda1eb", "e88d385bc1aa1af3fec9924a" ], "type": "operation", "deprecated": true, "scheduled": false, "retrySettings": { "state": [ "failure", "success", "failure", "error", "error" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "63ebfb2a6af8f1dfe01089d0", "4663747a1a1d81bf4d792a8b", "70fc47bb9ca3c124293f6105", "b0f38c84e248dce32f35e52b" ], "canvasVersion": 3, "_id": "5cb7b531d06cceb89fd21b1c", "namespace": { "type": "project", "name": "officia eiusmod", "accessControl": { "read": [ "nisi ut sed", "id culpa", "amet ut", "commodo labore dolore qui" ], "write": [ "in aliquip exercitation", "reprehenderit in elit pariatur Duis", "sed reprehenderit ad commodo adipisicing", "consectetur irure" ], "execute": [ "dolore sint velit nulla laboris", "anim esse magna fugiat", "sit cillum id", "ut Duis quis aliquip ea", "dolore aute labore id voluptate" ], "manage": [ "velit sunt fugiat do non", "velit ad laboris cupidatat consequat", "mollit consectetur in Ut" ] } }, "description": "ut laborum", "preAutomationTime": 250000, "font_size": 12, "created": "1988-12-18T02:06:09.372Z", "created_by": "04792f5cbbcb062d8dd2cf61", "last_updated": "1966-04-28T14:44:17.89Z", "last_updated_by": "5a92a7e201a1569283b134c4", "lastUpdatedVersion": "ut exercitation cupidatat ullamco", "tags": [ "exercitation dolor", "in irure Excepteur elit" ], "encodingVersion": 1 } ], "total": -1378691, "start": 55434678, "end": -19968084, "count": 46152285, "limit": -72352894, "next": "culpa in exercitation magna commodo", "previous": null }
{ "title": "result", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "workflowDocument" } }, "total": { "type": "integer", "description": "Total number of documents matching the given query parameters." }, "start": { "type": "integer", "description": "Search index of first document in the items array." }, "end": { "type": "integer", "description": "Search index of the last document in the items array." }, "count": { "type": "integer", "description": "Length of the items array." }, "limit": { "type": "integer", "description": "Number of results to return. Used for pagination." }, "next": { "description": "URI pointing to the next set of paginated results. Preserves previous search and projection parameters. Null if returning the last page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "previous": { "description": "URI pointing to the previous set of paginated results. Preserves previous search and projection parameters. Null if returning the first page of results.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } } }