provider Priority schemes GET /rest/api/3/priorityscheme
@utdk/jira /rest/api/3/priorityscheme
Get priority schemes
Returns a [paginated](#pagination) list of priority schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
startAt query
The index of the first item to return in a page of results (page offset).
string
maxResults query
The maximum number of items to return per page.
string
priorityId query
A set of priority IDs to filter by. To include multiple IDs, provide an ampersand-separated list. For example, `priorityId=10000&priorityId=10001`.
array
schemeId query
A set of priority scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `schemeId=10000&schemeId=10001`.
array
schemeName query
The name of scheme to search for.
string
onlyDefault query
Whether only the default priority is returned.
boolean
orderBy query
The ordering to return the priority schemes by.
enum: name, +name, -name
expand query
A comma separated list of additional information to return. "priorities" will return priorities associated with the priority scheme. "projects" will return projects associated with the priority scheme. `expand=priorities,projects`.
string

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getpriorityschemes
GET/rest/api/3/priorityscheme
Returns a [paginated](#pagination) list of priority schemes. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

The index of the first item to return in a page of results (page offset).

The maximum number of items to return per page.

A set of priority IDs to filter by. To include multiple IDs, provide an ampersand-separated list. For example, `priorityId=10000&priorityId=10001`.

A set of priority scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `schemeId=10000&schemeId=10001`.

The name of scheme to search for.

Whether only the default priority is returned.

The ordering to return the priority schemes by.

A comma separated list of additional information to return. "priorities" will return priorities associated with the priority scheme. "projects" will return projects associated with the priority scheme. `expand=priorities,projects`.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.getpriorityschemes({
  "startAt": "0",
  "maxResults": "50",
  "onlyDefault": false,
  "orderBy": "+name"
})