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, projecting, and sorting workflow documents. HTTP queries for the parameter 'in' take the form of '?in[name]=my-workflow'. However, the equivalent task query would be '{ `in`: { `name`: `my-workflow` } }'. Same thing applies for the parameters 'not-in', 'equals', 'contains', 'starts-with', and 'ends-with'.

Return

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