Get workflows paginated
GET
/rest/api/3/workflow/search
Workflows
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/workflow/search'
Response Response Example
200 - Success
{
"maxResults": 1,
"startAt": 0,
"total": 5,
"isLast": false,
"values": [
{
"id": {
"name": "SCRUM Workflow",
"entityId": "5ed312c5-f7a6-4a78-a1f6-8ff7f307d063"
},
"description": "A workflow used for Software projects in the SCRUM methodology",
"transitions": [
{
"id": "5",
"name": "In Progress",
"description": "Start working on the issue.",
"from": [
"10",
"13"
],
"to": "14",
"type": "directed",
"screen": {
"id": "10000",
"name": "Issue screen"
},
"rules": {
"conditionsTree": {
"nodeType": "compound",
"operator": "AND",
"conditions": [
{
"nodeType": "simple",
"type": "PermissionCondition",
"configuration": {
"permissionKey": "WORK_ON_ISSUES"
}
},
{
"nodeType": "simple",
"type": "PermissionCondition",
"configuration": {
"permissionKey": "RESOLVE_ISSUES"
}
}
]
},
"validators": [
{
"type": "FieldRequiredValidator",
"configuration": {
"ignoreContext": true,
"errorMessage": "A custom error message",
"fields": [
"description",
"assignee"
]
}
}
],
"postFunctions": [
{
"type": "UpdateIssueStatusFunction"
},
{
"type": "GenerateChangeHistoryFunction"
},
{
"type": "FireIssueEventFunction"
}
]
},
"properties": {
"jira.fieldscreen.id": 1
}
}
],
"statuses": [
{
"id": "3",
"name": "In Progress",
"properties": {
"jira.issue.editable": "false",
"issueEditable": false
}
}
],
"isDefault": false,
"schemes": [
{
"id": "10001",
"name": "Test Workflow Scheme"
}
],
"projects": [
{
"self": "project/EX",
"id": "10000",
"key": "EX",
"name": "Example",
"projectTypeKey": "ProjectTypeKey{key='software'}",
"simplified": false,
"avatarUrls": {
"48x48": "secure/projectavatar?size=large&pid=10000",
"24x24": "secure/projectavatar?size=small&pid=10000",
"16x16": "secure/projectavatar?size=xsmall&pid=10000",
"32x32": "secure/projectavatar?size=medium&pid=10000"
},
"projectCategory": {
"id": "10000",
"description": "Project category description",
"name": "A project category"
}
}
],
"hasDraftWorkflow": true,
"operations": {
"canEdit": true,
"canDelete": false
},
"created": "2023-07-12T06:03:05.758+0000",
"updated": "2023-07-12T06:03:05.758+0000"
}
]
}
Request
Query Params
startAt
integerÂ
optional
maxResults
integerÂ
optional
workflowName
array[string]
optional
workflowName=name1&workflowName=name2
.expand
stringÂ
optional
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.queryString
stringÂ
optional
orderBy
stringÂ
optional
name
Sorts by workflow name.created
Sorts by create time.updated
Sorts by update time.isActive
stringÂ
optional
Responses
Modified at 2023-07-13 03:27:27