Jira

Jira UI modifications (apps) API

UI modifications is a feature available for **Forge apps only**. It enables Forge apps to control how selected Jira and Jira Service Management fields behave on the following views: * Jira global issue create * Jira issue view * Jira issue transition * Jira Service Management request portal create. For example: hide specific fields, set them as required, etc.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /rest/api/3/uiModifications List my Forge app's UI modifications · Get UI modifications #
Ask an LLM
“Which UI modifications has my Forge app defined?”
“Can I include each UI modification's contexts in the listing?”
Tell an agent
List my app's UI modifications.
Show my UI modifications with {expand} expanded.
POST /rest/api/3/uiModifications Create a UI modification · Create UI modification #
Ask an LLM
“How do I create a UI modification for my Forge app?”
“How many UI modifications and contexts can one app define?”
Tell an agent
Create a UI modification named {name}.
Create UI modification {name} applied to contexts {contexts}.
DELETE /rest/api/3/uiModifications/{uiModificationId} Delete a UI modification · Delete UI modification #
Ask an LLM
“Can I delete a UI modification my Forge app no longer needs?”
“Are a UI modification's contexts removed when it's deleted?”
Tell an agent destructive · confirm first
Delete UI modification {uiModificationId}.
Remove UI modification {uiModificationId} and all its contexts.
PUT /rest/api/3/uiModifications/{uiModificationId} Update a UI modification · Update UI modification #
Ask an LLM
“Can I change the contexts or data of an existing UI modification?”
“Is it possible to rename a UI modification after creating it?”
Tell an agent
Rename UI modification {uiModificationId} to {name}.
Set UI modification {uiModificationId}'s contexts to {contexts}.

Documentation

📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
📖
Authentication
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
📖
Documentation
https://developer.atlassian.com/cloud/jira/software/rest/intro/
📖
Documentation
https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
📖
APIReference
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-ui-modifications-apps-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jira:jira-ui-modifications-apps-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jira-ui-modifications-apps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: ecosystem@atlassian.com
  description: Jira Cloud platform REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  title: Jira Cloud platform REST UI modifications (apps) API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-ui-modifications-apps-api-openapi.yml