---
title: "Get UI modifications"
method: GET
path: "/rest/api/3/uiModifications"
tags: ["UI modifications (apps)"]
---

# Get UI modifications

`GET /rest/api/3/uiModifications`

Gets UI modifications. UI modifications can only be retrieved by Forge apps.

**[Permissions](#permissions) required:** None.

The new `read:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.

## Query parameters

- `startAt` integer
- `maxResults` integer
- `expand` string

## Response `200`

Returned if the request is successful.

- PageBeanUiModificationDetails — 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` UiModificationDetails[] — The list of items.
    - `contexts` UiModificationContextDetails[] — List of contexts of the UI modification. The maximum number of contexts is 1000.
      - `id` string — The ID of the UI modification context.
      - `isAvailable` boolean — Whether a context is available. For example, when a project is deleted the context becomes unavailable.
      - `issueTypeId` string — The issue type ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all issue types. Each UI modification context can have a maximum of one wildcard.
      - `portalId` string — The portal ID of the context. Only required for Jira Service Management request create portal view (`JSMRequestCreate`).
      - `projectId` string — The project ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all projects. Each UI modification context can have a maximum of one wildcard.
      - `requestTypeId` string — The request type ID of the context. Only required for Jira Service Management request create portal view (`JSMRequestCreate`).
      - `viewType` 'GIC' | 'IssueView' | 'IssueTransition' | 'JSMRequestCreate' — The view type of the context. Supported values: * `GIC` \- Jira global issue create * `IssueView` \- Jira issue view * `IssueTransition` \- Jira issue transition * `JSMRequestCreate` \- Jira Service Management request create portal view For Jira view types (`GIC`, `IssueView`, `IssueTransition`), null is treated as a wildcard, meaning the UI modification will be applied to all view types. Each Jira context can have a maximum of one wildcard. Wildcards are not applicable for JSM contexts.
    - `data` string — The data of the UI modification. The maximum size of the data is 50000 characters.
    - `description` string — The description of the UI modification. The maximum length is 255 characters.
    - `id` string, required — The ID of the UI modification.
    - `name` string, required — The name of the UI modification. The maximum length is 255 characters.
    - `self` string, required — The URL of the UI modification.

## Other responses

- `400` — Returned if the request is not valid.
- `401` — Returned if the authentication credentials are incorrect or missing.
- `403` — Returned if the request is not from a Forge app.

---

[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/versions/5a51740d7ab3/schema)