---
title: "Get screen schemes"
method: GET
path: "/rest/api/3/screenscheme"
tags: ["Screen schemes"]
---

# Get screen schemes

`GET /rest/api/3/screenscheme`

Returns a [paginated](#pagination) list of screen schemes.

Only screen schemes used in classic projects are returned.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

## Query parameters

- `startAt` integer
- `maxResults` integer
- `id` integer[]
- `expand` string
- `queryString` string
- `orderBy` 'name' | '-name' | '+name' | 'id' | '-id' | '+id'

## Response `200`

Returned if the request is successful.

- PageBeanScreenScheme — A page of items.
  - `isLast` boolean — Whether this is the last page.
  - `maxResults` integer — The maximum number of items that could be returned.
  - `nextPage` string, uri — If there is another page of results, the URL of the next page.
  - `self` string, uri — The URL of the page.
  - `startAt` integer — The index of the first item returned.
  - `total` integer — The number of items returned.
  - `values` ScreenScheme[] — The list of items.
    - `description` string — The description of the screen scheme.
    - `id` integer — The ID of the screen scheme.
    - `issueTypeScreenSchemes` PageBeanIssueTypeScreenScheme — A page of items.
      - `isLast` boolean — Whether this is the last page.
      - `maxResults` integer — The maximum number of items that could be returned.
      - `nextPage` string, uri — If there is another page of results, the URL of the next page.
      - `self` string, uri — The URL of the page.
      - `startAt` integer — The index of the first item returned.
      - `total` integer — The number of items returned.
      - `values` IssueTypeScreenScheme[] — The list of items.
        - `description` string — The description of the issue type screen scheme.
        - `id` string, required — The ID of the issue type screen scheme.
        - `name` string, required — The name of the issue type screen scheme.
    - `name` string — The name of the screen scheme.
    - `screens` ScreenTypes — The IDs of the screens for the screen types of the screen scheme.
      - `create` integer — The ID of the create screen.
      - `default` integer, required — The ID of the default screen. Required when creating a screen scheme.
      - `edit` integer — The ID of the edit screen.
      - `view` integer — The ID of the view screen.

## Other responses

- `401` — Returned if the authentication credentials are incorrect or missing.
- `403` — Returned if the user does not have the necessary permission.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/revisions/5a51740d7ab3/schema)