Workflows

Search workflows

Changed on

Returns a paginated 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 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
get/rest/api/3/workflows/search

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/workflows/search
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-configuration

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.

expandstring

Use expand 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.
queryStringstring

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

orderBystring

Order the results by a field:

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

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

isActiveboolean

Filters active and inactive workflows.

projectIdinteger

The ID of the project to filter the workflows by. Only workflows associated with the given project are returned.

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

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

selfstring

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

  • 23cd462c2497Revision changes
    • info

      added the new optional query request parameter projectId

  • 10c4041677d4Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      removed the assignee enum value from the ///// response property for the response status

    • info

      removed the reporter enum value from the ///// response property for the response status