GET /rest/api/2/uiModifications

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

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.

Servers

Query parameters

Name Type Required Description
startAt Integer No

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

Default value: 0

maxResults Integer No

The maximum number of items to return per page.

Default value: 50

expand String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.