Bulk get workflows - JIRA 7.6.1

Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.

Permissions required:

Administer Jira project permission to access all, including global-scoped, workflows

At least one of the Administer projects and View (read-only) workflow project permissions to access project-scoped workflows

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/workflows' \ --header 'Content-Type: application/json' \ --data-raw '{ "projectAndIssueTypes": [], "workflowIds": [], "workflowNames": [ "Workflow 1", "Workflow 2" ] }'

{"statuses":[{"id":"10001","statusReference":"10001","name":"To Do","statusCategory":"TODO","scope":{"type":"GLOBAL"},"description":"","usages":[]},{"id":"10002","statusReference":"10002","name":"In Progress","statusCategory":"IN_PROGRESS","scope":{"type":"GLOBAL"},"description":"","usages":[]},{"id":"10003","statusReference":"10003","name":"Done","statusCategory":"DONE","scope":{"type":"GLOBAL"},"description":"","usages":[]}],"workflows":[{"scope":{"type":"GLOBAL"},"version":{"versionNumber":0,"id":"f010ac1b-3dd3-43a3-aa66-0ee8a447f76e"},"id":"b9ff2384-d3b6-4d4e-9509-3ee19f607168","name":"Workflow 1","description":"","isEditable":true,"startPointLayout":{"x":-100.00030899047852,"y":-153.00020599365234},"usages":[],"statuses":[{"statusReference":"10001","layout":{"x":114.99993896484375,"y":-16.0},"properties":{},"deprecated":false},{"statusReference":"10002","layout":{"x":317.0000915527344,"y":-16.0},"properties":{},"deprecated":false},{"statusReference":"10003","layout":{"x":508.000244140625,"y":-16.0},"properties":{},"deprecated":false}],"transitions":[{"id":"31","type":"GLOBAL","from":[],"to":{"statusReference":"10003"},"name":"Done","description":"","actions":[],"validators":[],"triggers":[],"properties":{}},{"id":"11","type":"GLOBAL","from":[],"to":{"statusReference":"10001"},"name":"To Do","description":"","actions":[],"validators":[],"triggers":[],"properties":{}},{"id":"21","type":"GLOBAL","from":[],"to":{"statusReference":"10002"},"name":"In Progress","description":"","actions":[],"validators":[],"triggers":[],"properties":{}},{"id":"1","type":"INITIAL","from":[],"to":{"statusReference":"10001"},"name":"Create","description":"","actions":[],"validators":[],"triggers":[],"properties":{}}]}]}

Request

Query Params

expand

string

optional

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

workflows.usages Returns the project and issue types that each workflow is associated with.

statuses.usages Returns the project and issue types that each status is associated with.

Body Params application/json

projectAndIssueTypes

array[object (ProjectAndIssueTypePair) {2}]

optional

The list of projects and issue types to query.

issueTypeId

string

required

The ID of the issue type.

projectId

string

required

The ID of the project.

workflowIds

array[string]

optional

The list of workflow IDs to query.

workflowNames

array[string]

optional

The list of workflow names to query.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

Details of workflows and related statuses.

statuses

array[object (JiraWorkflowStatus) {7}]

optional

List of statuses.

description

string

optional

The description of the status.

string

optional

The ID of the status.

name

string

optional

The name of the status.

scope

object (WorkflowScope)

optional

The scope of the workflow.

statusCategory

enum<string>

optional

The category of the status.

Allowed values:

TODOIN_PROGRESSDONE

statusReference

string

optional

The reference of the status.

usages

array[object (ProjectIssueTypes) {2}]

optional

The statuses.usages expand is an optional parameter that can be used when reading and updating statuses in Jira. It provides additional information about the projects and issue types associated with the requested statuses.

workflows

array[object (JiraWorkflow) {11}]

optional

List of workflows.

description

string

optional

The description of the workflow.

string

optional

The ID of the workflow.

isEditable

boolean

optional

Indicates if the workflow can be edited.

name

string

optional

The name of the workflow.

scope

object (WorkflowScope)

optional

The scope of the workflow.

startPointLayout

object (WorkflowLayout) | null

optional

The starting point for the statuses in the workflow.

statuses

array[object (WorkflowReferenceStatus) {4}]

optional

The statuses referenced in this workflow.

taskId

string | null

optional

If there is a current asynchronous task operation for this workflow.

transitions

array[object (WorkflowTransitions) {13}]

optional

The transitions of the workflow.

usages

array[object (ProjectIssueTypes) {2}]

optional

The workflows.usages expand is an optional parameter that can be used when reading and updating workflows in Jira. It provides additional information about the projects and issue types associated with the requested workflows.

version

object (DocumentVersion)

optional

The version details of the workflow.

🟠400Returned if the request is not valid.

🟠401Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation.