v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Workflows

Get workflows paginated

This will be removed on June 1, 2026; use Search workflows instead.

Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.

This operation does not return next-gen workflows.

Permissions required: Administer Jira global permission.

get/rest/api/3/workflow/search

Query parameters

startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

workflowNamestring[]

The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, workflowName=name1&workflowName=name2.

expandstring

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

  • transitions For each workflow, returns information about the transitions inside the workflow.
  • transitions.rules For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested.
  • transitions.properties For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested.
  • statuses For each workflow, returns information about the statuses inside the workflow.
  • statuses.properties For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested.
  • default For each workflow, returns information about whether this is the default workflow.
  • schemes For each workflow, returns information about the workflow schemes the workflow is assigned to.
  • projects For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes.
  • hasDraftWorkflow For each workflow, returns information about whether the workflow has a draft version.
  • operations For each workflow, returns information about the actions that can be undertaken on the workflow.
queryStringstring

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

orderBy'name' | '-name' | '+name' | 'created' | '-created' | '+created' | 'updated' | '+updated' | '-updated'

Order the results by a field:

  • name Sorts by workflow name.
  • created Sorts by create time.
  • updated Sorts by update time.
isActiveboolean

Filters active and inactive workflows.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.