Screens

Get screens

Changed on

Returns a paginated list of all screens or those specified by one or more screen IDs.

Permissions required: Administer Jira global permission.

get/rest/api/3/screens

Request

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

Query parameters

startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

idinteger[]

The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

queryStringstring

String used to perform a case-insensitive partial match with screen name.

scopestring[]

The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, scope=GLOBAL&scope=PROJECT.

orderBy'name' | '-name' | '+name' | 'id' | '-id' | '+id'

Order the results by a field:

  • id Sorts by screen ID.
  • name Sorts by screen name.

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

  • 75c9c58763c9Revision changes
    • warning

      added the new product_discovery enum value to the //////////// response property for the response status