provider Screens GET /rest/api/3/screens
@utdk/jira /rest/api/3/screens
Get screens
Returns a [paginated](#pagination) list of all screens or those specified by one or more screen IDs. **[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).
integer
maxResults query
The maximum number of items to return per page.
integer
id query
The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.
array
queryString query
String used to perform a case-insensitive partial match with screen name.
string
scope query
The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, `scope=GLOBAL&scope=PROJECT`.
array
orderBy query
[Order](#ordering) the results by a field: * `id` Sorts by screen ID. * `name` Sorts by screen name.
enum: name, -name, +name, id…

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.

getscreens
GET/rest/api/3/screens
Returns a [paginated](#pagination) list of all screens or those specified by one or more screen IDs. **[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.

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

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

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

[Order](#ordering) the results by a field: * `id` Sorts by screen ID. * `name` Sorts by screen name.

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.getscreens({
  "startAt": 0,
  "maxResults": 100
})