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": 25, "skip": 10, "order": 1, "sort": "name", "include": "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" } }
{ "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" ] }, "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" ] } } } }, "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": [ "6fd7bb88247b3c0e622101b7", "93519bc258533a1cab73d350" ], "nodeLocation": { "x": 35776426.72850451, "y": 67532427.36060551 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "687fdf6c84939f55bb2673b9", "801231489f6cef788e07d00d", "ca3513cd2907782062328880", "4a8ec6b5e20e1e93c73d2ce1" ], "nodeLocation": { "x": -33297096.274098516, "y": 58026100.92509055 } }, "error_handler": { "name": "childJob", "summary": "ea adipisicing", "description": "commodo eu Ut amet nulla", "app": "ea officia laboris", "variables": { "error": "" }, "groups": [ "878507218555273d0d1fe304", "bf6874e25562a9fc77175679", "897b2ebe2f6a6f9a54c7d52d", "8a229051cc91816342eff085", "04b5fccd06bde3fa93b47d1a" ], "type": "operation", "deprecated": true, "scheduled": true, "retrySettings": { "state": [ "failure", "error", "error", "error" ], "autoRetry": false, "limit": 20, "delay": 2000, "count": 5 } } }, "transitions": {}, "groups": [ "44e89b9de9eb889dae4c3723", "0b03151c8bc6ac3a9a6b6d6d", "8ee25a84a74d0d55a4933030", "4afc3dce9974209ece25d294", "f63726220f43385ec880f044" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": "sit", "preAutomationTime": 250000, "font_size": 12, "created": "1982-12-29T20:37:34.62Z", "created_by": "b20f0cb321bf47de4b9fcfa2", "last_updated": "2006-05-01T21:12:56.263Z", "last_updated_by": "271838ed629c534cbddb44ac", "lastUpdatedVersion": "nulla ut qui culpa", "tags": [ "Duis" ], "canvasVersion": 1, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "9abc6b62cbf854bb2cb23da0", "96e3029496337e2fa5385c8d", "56e535f176e72f5d6f098f78", "4207eded30b8d04965386c97", "3c2221cdc048cf2ef8962068" ], "nodeLocation": { "x": 85023044.86046886, "y": -54160731.77114424 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "ba22c70970180a08138fa725", "e00447baf881181327736fbe", "dbd35d31a945b47dc7fc18d6", "21be7f3cf909e5903f98c578" ], "nodeLocation": { "x": 57343125.41703844, "y": -92333309.23575008 } }, "error_handler": { "name": "childJob", "summary": "tempor velit aliqua id", "description": "non exercitation ut in", "app": "velit anim do", "variables": { "error": "" }, "groups": [ "15a9b188257ff865dfbe0362" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "error", "error" ], "autoRetry": false, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "5abe7e65c2d6fab7d6ff90e7", "4266612f0534c36175934e0b", "5ed61f8a832ccf1be5b7accd", "96a8c0ebf1dbea2f817457c9", "9e66b9ec0ea535fec2858042" ], "_id": "4321abcdef694aa79dae47ad", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2025-05-09T13:19:32.217Z", "created_by": "862705e3a3751915cdbe5361", "last_updated": "1969-11-13T03:53:41.251Z", "last_updated_by": "d9c6750e62df0248edf2df04", "lastUpdatedVersion": "labore", "tags": [ "consectetur", "sed cupidatat" ], "canvasVersion": 2, "encodingVersion": 1 }, { "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ "3db753a4b178163c1ec1a4c1", "631f905aebbe7fef7d0d60dd", "a952f264a5557f9fa4bca84f", "8de643ee817b288c9c192af5", "cceab1f24c4e8801a8de095c" ], "nodeLocation": { "x": 25393494.72739479, "y": -10250527.477034718 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ "15e16eab1d1b4557aea77c3f" ], "nodeLocation": { "x": -42219576.10762037, "y": -40320102.98783284 } }, "error_handler": { "name": "childJob", "summary": "ut nulla do cillum officia", "description": "aliquip dolore ullamco", "app": "proident enim aliquip ullamco", "variables": { "error": "" }, "groups": [ "3d3ff575368ba1f5871c2f36", "2ce19c2ea47c7b5264a36f9d" ], "type": "operation", "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "failure", "failure", "success", "error", "success" ], "autoRetry": true, "limit": 10, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ "239994e1a5ad02305273b4e6" ], "_id": "5cb7b531d06cceb89fd21b1c", "description": null, "preAutomationTime": 250000, "font_size": 12, "created": "2009-01-19T01:57:04.838Z", "created_by": "ce9ad4c1fd9ebf56a2a93211", "last_updated": "1967-09-14T04:33:05.843Z", "last_updated_by": "28810a3200f62fed2917cf53", "lastUpdatedVersion": "in", "tags": [ "in Excepteur ut deserunt", "nulla", "sunt labore", "consectetur Ut", "sit voluptate ea" ], "canvasVersion": 1, "encodingVersion": 1 } ], "total": 90931719, "start": -23168738, "end": 19807126, "count": -25647458, "limit": 94809229, "next": "sed in amet ad velit", "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" } ] } } }