How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
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.

Documentation Provider Profile APIs.io OpenAPI GitHub

Jira UI modifications (apps) API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include UI Modifications (Apps). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 4 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

Requests are made against a single base URL, https://your-domain.atlassian.net.

4 operations 2 paths 7 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
Contact
ecosystem@atlassian.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Jira UI modifications (apps) API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

UI Modifications (Apps) 4

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: J…

GET
/rest/api/3/uiModifications
Get UI modifications
getUiModifications 3 params → 200400401403
POST
/rest/api/3/uiModifications
Create UI modification
createUiModification body → 201400401403404
DELETE
/rest/api/3/uiModifications/{uiModificationId}
Delete UI modification
deleteUiModification 1 param → 204401403404
PUT
/rest/api/3/uiModifications/{uiModificationId}
Update UI modification
updateUiModification 1 param body → 204400401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are UiModificationContextDetails (7 properties), PageBeanUiModificationDetails (7 properties), UiModificationDetails (6 properties), UpdateUiModificationDetails (4 properties). Each schema is shown below with its type and property counts.

CreateUiModificationDetails
object
The details of a UI modification.
4 properties 1 required
PageBeanUiModificationDetails
object
A page of items.
7 properties
UiModificationContextDetails
object
The details of a UI modification's context, which define where to activate the UI modification.
7 properties
UpdateUiModificationDetails
object
The details of a UI modification.
4 properties
UiModificationIdentifiers
object
Identifiers for a UI modification.
2 properties 2 required
DetailedErrorCollection
object
3 properties
UiModificationDetails
object
The details of a UI modification.
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-ui-modifications-apps-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
AE Profile APIs.io
Jira Service Management Operations REST API
AE Profile APIs.io
Jira Align REST API
AE Profile APIs.io
Jira Customer Service Management REST API
AE Profile APIs.io
Jira Issue Comments API
AE Profile APIs.io
Jira Issue Priorities API
AE Profile APIs.io
Jira Issue Search API
AE Profile APIs.io
Jira Issue Statuses API
AE Profile APIs.io
Jira Issue Transitions API
AE Profile APIs.io
Jira Issue Types API
AE Profile APIs.io
Jira Issues API
AE Profile APIs.io
Jira Projects API
AE Profile APIs.io
#UI Modifications (Apps)
← Back to J APIs
API Details
ID
jira:jira-ui-modifications-apps-api
Base URL
https://your-domain.atlassian.net/rest/api/2
Docs
https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/
Provider
Jira
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=jira-ui-modifications-apps-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/jira-ui-modifications-apps-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Jira UI modifications (apps) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.