Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Workflow Automation

List workflows

List all workflows in your organization. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

get/api/v2/workflows

Query parameters

limitinteger

The maximum number of workflows to return per page.

pageinteger

The page number to return, starting from 0.

sortstring

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.

filter[query]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.

filter[triggerIds]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.

filter[includeUnpublished]boolean

Whether to include unpublished workflows in the response.

filter[includeSpecs]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.

Response

OK