UI modifications (apps)

Get UI modifications

Changed on

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.

get/rest/api/3/uiModifications

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/uiModifications
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-work

Query parameters

startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

expandstring

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.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

  • 6137ec1b19d0Revision changes
    • warning

      added the new GICAgentView enum value to the //// response property for the response status

    • warning

      added the new IssueTransitionAgentView enum value to the //// response property for the response status

    • warning

      added the new IssueViewAgentView enum value to the //// response property for the response status

  • 5021849ab549Revision changes
    • warning

      added the new JSMRequestCreate enum value to the //// response property for the response status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status