Atlassian Screens API

The Screens API from Atlassian — 5 operation(s) for screens.

Documentation 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 · Atlassian Get Screens For A Field #

Ask an LLM

“Which Jira screens is this custom field used on?”

“Before removing a field, how can I see every screen that shows it?”

Tell an agent

List the screens that use field {fieldId}.

Show where field {fieldId} appears, with {expand} expanded.

GET /rest/api/3/screens List or search screens · Atlassian Get Screens #

Ask an LLM

“What screens are configured in my Jira site?”

“Can I search screens by name or restrict them by scope?”

Tell an agent

List all Jira screens.

Find screens whose name contains {queryString}.

POST /rest/api/3/screens Create a screen · Atlassian Create Screen #

Ask an LLM

“How do I create a new Jira screen?”

“Does a newly created screen come with a field tab?”

Tell an agent

Create a screen named {name}.

Create screen {name} described as {description}.

POST /rest/api/3/screens/addToDefault/{fieldId} Add a field to the default screen · Atlassian Add Field To Default Screen #

Ask an LLM

“How do I put a custom field on Jira's default screen?”

“Can I add a field to the default tab without picking a screen?”

Tell an agent

Add field {fieldId} to the default screen.

Put custom field {fieldId} on the default tab of the default screen.

DELETE /rest/api/3/screens/{screenId} Delete a screen · Atlassian Delete Screen #

Ask an LLM

“How do I delete a Jira screen I no longer need?”

“Why can't a screen be deleted while a workflow uses it?”

Tell an agent destructive · confirm first

Delete screen {screenId}.

Remove unused screen {screenId}.

PUT /rest/api/3/screens/{screenId} Rename or redescribe a screen · Atlassian Update Screen #

Ask an LLM

“How do I rename a Jira screen?”

“Can screens in team-managed projects be updated?”

Tell an agent

Rename screen {screenId} to {name}.

Update the description of screen {screenId} to {description}.

GET /rest/api/3/screens/{screenId}/availableFields List fields that can be added to a screen · Atlassian Get Available Screen Fields #

Ask an LLM

“Which fields aren't on this screen yet and can be added?”

“What fields are available to put on a screen tab?”

Tell an agent

List the fields available to add to screen {screenId}.

Show which fields I could add to a tab on screen {screenId}.

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/atlassian:atlassian-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

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: http://atlassian.com/terms/
  title: Atlassian The Jira Cloud platform REST Screens API
  version: 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
servers:
- url: https://your-domain.atlassian.net
tags:


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

Atlassian Screens API

Operations 7

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification