Issue priorities

Search priorities

Changed on

Returns a paginated list of priorities. The list can contain all priorities or a subset determined by any combination of these criteria:

  • a list of priority IDs. Any invalid priority IDs are ignored.
  • a list of project IDs. Only priorities that are available in these projects will be returned. Any invalid project IDs are ignored.
  • whether the field configuration is a default. This returns priorities from company-managed (classic) projects only, as there is no concept of default priorities in team-managed projects.

Deprecation notice: The onlyDefault parameter is deprecated and will be removed at a later date. See CHANGE-1655.

Deprecation notice: The isDefault property of priorities is deprecated and will be removed at a later date. See CHANGE-1655.

Permissions required: Permission to access Jira.

get/rest/api/3/priority/search

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/priority/search
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-configuration

Query parameters

startAtstring

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

maxResultsstring

The maximum number of items to return per page.

idstring[]

The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=2&id=3.

projectIdstring[]

The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, projectId=10010&projectId=10111.

priorityNamestring

The name of priority to search for.

onlyDefaultboolean

Whether only the default priority is returned.

expandstring

Use schemes to return the associated priority schemes for each priority. Limited to returning first 15 priority schemes per priority.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

  • 23cd462c2497Revision changes
    • info

      endpoint reactivated

  • 6abe311e7b55Revision changes
    • info

      endpoint deprecated

    • info

      added the new optional query request parameter expand

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status