GET /rest/api/2/screens

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

Permissions required: Administer Jira global permission.

Servers

Query parameters

Name Type Required Description
id[] Array No

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

startAt Integer No

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

Default value: 0

maxResults Integer No

The maximum number of items to return per page.

Default value: 100

orderBy String No

Order the results by a field:

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

Possible values:

  • "id"
  • "name"
  • "-name"
  • "-id"
  • "+id"
  • "+name"
scope[] Array No

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

queryString String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.