Interface WorkflowAutomationApiListWorkflowsRequest

Hierarchy

  • WorkflowAutomationApiListWorkflowsRequest

Properties

filterIncludeSpecs?: boolean

Whether to include the full spec of each workflow in the response. When false (the default), each workflow's spec is returned as null.

filterIncludeUnpublished?: boolean

Whether to include unpublished workflows in the response.

filterQuery?: string

A search query used to filter the returned workflows. The query performs a case-insensitive substring match against each workflow's name, creator name, and handle. If the query contains a colon (for example, team:infra), the query is treated as a key:value tag filter.

filterTriggerIds?: string[]

Filters the returned workflows by one or more trigger types, such as monitor, schedule, or githubWebhook. To specify the multiple types, repeat this parameter.

limit?: number

The maximum number of workflows to return per page.

page?: number

The page number to return, starting from 0.

sort?: string

The sort order for the returned workflows. Provide a comma-separated list of fields, each optionally prefixed with - for descending order. Supported fields are name, createdAt, updatedAt, creatorName, ownerName, and lastExecutedAt.

Generated using TypeDoc