provider UI modifications (apps) GET /rest/api/3/uiModifications
@utdk/jira /rest/api/3/uiModifications
Get UI modifications
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.
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
expand query
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `data` Returns UI modification data. * `contexts` Returns UI modification contexts.
string

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.

getuimodifications
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.

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

The maximum number of items to return per page.

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * `data` Returns UI modification data. * `contexts` Returns UI modification contexts.

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