Get Workflows Paginated
GET {{baseUrl}}/rest/api/3/workflow/search?startAt=0&maxResults=50&workflowName=<string>&expand=<string>
Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.
This operation does not return next-gen workflows.
Permissions required: Administer Jira global permission.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
startAt | number | The index of the first item to return in a page of results (page offset). | |
maxResults | number | The maximum number of items to return per page. | |
workflowName | string | The name of a workflow to return. | |
expand | string | Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: |
transitionsFor each workflow, returns information about the transitions inside the workflow.transitions.rulesFor each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested.statusesFor each workflow, returns information about the statuses inside the workflow.statuses.propertiesFor each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested. |
RESPONSES
status: OK
{"maxResults":1,"startAt":0,"total":5,"isLast":false,"values":[{"id":{"name":"SCRUM Workflow"},"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"},"rules":{"conditions":[{"type":"PermissionCondition","configuration":{"permissionKey":"WORK_ON_ISSUES"}}],"validators":[{"type":"FieldRequiredValidator","configuration":{"ignoreContext":true,"errorMessage":"A custom error message","fields":["description","assignee"]}}],"postFunctions":[{"type":"UpdateIssueStatusFunction"},{"type":"GenerateChangeHistoryFunction"},{"type":"FireIssueEventFunction"}]}}],"statuses":[{"id":"3","name":"In Progress","properties":{"issueEditable":false}}]}]}