Jira

Jira Screens API

This resource represents the screens used to record issue details. Use it to: * get details of all screens. * get details of all the fields available for use on screens. * create screens. * delete screens. * update screens. * add a field to the default screen.

GitHub OpenAPI

Operations 7

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/field/{fieldId}/screens List the screens a field appears on · Get screens for a field #
Ask an LLM
“Which screens is a particular field used on?”
“Can I see every screen that shows a custom field?”
Tell an agent
List the screens that use field {fieldId}.
Show screens containing field {fieldId}, expanded with {expand}.
GET /rest/api/3/screens List or search screens · Get screens #
Ask an LLM
“What screens are configured on my Jira site?”
“Can I search screens by name or filter them by scope?”
Tell an agent
List all screens.
Search screens whose name contains {queryString}.
POST /rest/api/3/screens Create a screen · Create screen #
Ask an LLM
“How do I create a new screen?”
“Does a newly created screen come with a default tab?”
Tell an agent
Create a screen named {name}.
Create screen {name} with description {description}.
POST /rest/api/3/screens/addToDefault/{fieldId} Add a field to the default screen · Add field to default screen #
Ask an LLM
“How do I put a field on the default screen's default tab?”
“Can I quickly make a new custom field visible on the default screen?”
Tell an agent
Add field {fieldId} to the default screen.
Put field {fieldId} on the default tab of the default screen.
DELETE /rest/api/3/screens/{screenId} Delete a screen · Delete screen #
Ask an LLM
“How do I delete a screen I no longer use?”
“Why can't I delete a screen that's in a screen scheme or workflow?”
Tell an agent destructive · confirm first
Delete screen {screenId}.
Remove unused screen {screenId}.
PUT /rest/api/3/screens/{screenId} Rename or redescribe a screen · Update screen #
Ask an LLM
“Can I rename a screen used in a classic project?”
“How do I change a screen's description?”
Tell an agent
Rename screen {screenId} to {name}.
Set screen {screenId}'s description to {description}.
GET /rest/api/3/screens/{screenId}/availableFields List fields that can be added to a screen · Get available screen fields #
Ask an LLM
“Which fields could I still add to a screen?”
“What fields are available but not yet on a screen's tabs?”
Tell an agent
List the fields available to add to screen {screenId}.
Show fields not yet placed on screen {screenId}.

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-screens-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-screens-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-screens-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 Screens API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


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