GET /rest/api/2/workflow/search

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.

Servers

Query parameters

Name Type Required Description
startAt Integer No

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

Default value: 0

maxResults Integer No

The maximum number of items to return per page.

Default value: 50

orderBy String No

Order the results by a field:

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

Possible values:

  • "+created"
  • "updated"
  • "created"
  • "+updated"
  • "name"
  • "-name"
  • "-created"
  • "+name"
  • "-updated"
expand String No

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.
isActive Boolean No

Filters active and inactive workflows.

queryString String No

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

workflowName[] Array No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.