Own The? Customize your docs with AI search, analytics, and more.

GET

Get screens

https://your-domain.atlassian.net/rest/api/3/screens

Returns a paginated list of all screens or those specified by one or more screen IDs. **Permissions required:** *Administer Jira* global permission.

Access Token Required: API Key

Query Params

startAtintegerDefault: 0

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

maxResultsintegerDefault: 100

The maximum number of items to return per page.

idarray

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

queryStringstringDefault:

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

scopearray

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

orderBystring

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

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

curl --request GET \
     --url 'https://your-domain.atlassian.net/rest/api/3/screens' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

GET