app-automation_studio

On this page:

getWorkflows

Summary

Gets a page of workflow documents.

Description

Gets a page of workflow documents.

Route

GET /automation-studio/workflows

Roles

admin readonly apiread designer

Parameters

DetailsExampleSchema
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'

Return

DetailsExampleSchema
Name Type Description
result object Results for the given search parameters.