POST /rest/api/2/workflows
Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.
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
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
useApprovalConfiguration |
Boolean | No |
Return the new field Default value: false |
expand |
String | No |
Deprecated. See the deprecation notice for details. Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
workflowIds[] |
Array | No |
The list of workflow IDs to query. |
workflowNames[] |
Array | No |
The list of workflow names to query. |
projectAndIssueTypes[] |
Array | No |
The list of projects and issue types to query. |
projectAndIssueTypes[].projectId |
String | Yes |
The ID of the project. |
projectAndIssueTypes[].issueTypeId |
String | Yes |
The ID of the issue type. |
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.