GET /rest/api/2/workflows/search
Returns a paginated list of global and project workflows. If workflow names are specified in 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
Servers
- https://your-domain.atlassian.net
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
startAt |
Integer | No |
The index of the first item to return in a page of results (page offset). |
maxResults |
Integer | No |
The maximum number of items to return per page. |
orderBy |
String | No |
Order the results by a field:
|
expand |
String | No |
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
|
isActive |
Boolean | No |
Filters active and inactive workflows. |
scope |
String | No |
The scope of the workflow. Global for company-managed projects and Project for team-managed projects. |
queryString |
String | No |
String used to perform a case-insensitive partial match with workflow name. |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.