provider Workflows GET /rest/api/3/workflows/search
@utdk/jira /rest/api/3/workflows/search
Search workflows
Returns a [paginated](#pagination) list of global and project workflows. If workflow names are specified in the query string, details of those workflows are returned. Otherwise, all workflows are returned. **[Permissions](#permissions) required:** * *Administer Jira* global permission to access all, including project-scoped, workflows * At least one of the *Administer projects* and *View (read-only) workflow* project permissions to access project-scoped workflows
startAt query
The index of the first item to return in a page of results (page offset).
integer
maxResults query
The maximum number of items to return per page.
integer
expand query
Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `values.transitions` Returns the transitions that each workflow is associated with.
string
queryString query
String used to perform a case-insensitive partial match with workflow name.
string
orderBy query
[Order](#ordering) the results by a field: * `name` Sorts by workflow name. * `created` Sorts by create time. * `updated` Sorts by update time.
string
scope query
The scope of the workflow. Global for company-managed projects and Project for team-managed projects.
string
isActive query
Filters active and inactive workflows.
boolean

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
searchworkflows
GET/rest/api/3/workflows/search
Returns a [paginated](#pagination) list of global and project workflows. If workflow names are specified in the query string, details of those workflows are returned. Otherwise, all workflows are returned. **[Permissions](#permissions) required:** * *Administer Jira* global permission to access all, including project-scoped, workflows * At least one of the *Administer projects* and *View (read-only) workflow* project permissions to access project-scoped workflows

The index of the first item to return in a page of results (page offset).

The maximum number of items to return per page.

Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `values.transitions` Returns the transitions that each workflow is associated with.

String used to perform a case-insensitive partial match with workflow name.

[Order](#ordering) the results by a field: * `name` Sorts by workflow name. * `created` Sorts by create time. * `updated` Sorts by update time.

The scope of the workflow. Global for company-managed projects and Project for team-managed projects.

Filters active and inactive workflows.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.searchworkflows()