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

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.

Jira Screens API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Screens. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 7 operations across 5 paths, and defines 12 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.

7 operations 5 paths 12 schemas 1 DELETE3 GET2 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
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Jira Screens 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 7

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

Screens 7

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 screen…

GET
/rest/api/3/field/{fieldId}/screens
Get screens for a field
getScreensForField 4 params → 200401403
GET
/rest/api/3/screens
Get screens
getScreens 6 params → 200401403
POST
/rest/api/3/screens
Create screen
createScreen body → 201400401403
POST
/rest/api/3/screens/addToDefault/{fieldId}
Add field to default screen
addFieldToDefaultScreen 1 param → 200400401403404
DELETE
/rest/api/3/screens/{screenId}
Delete screen
deleteScreen 1 param → 204400401403404
PUT
/rest/api/3/screens/{screenId}
Update screen
updateScreen 1 param body → 200400401403404
GET
/rest/api/3/screens/{screenId}/availableFields
Get available screen fields
getAvailableScreenFields 1 param → 200401403404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ProjectDetails (8 properties), PageBeanScreen (7 properties), PageBeanScreenWithTab (7 properties), ScreenWithTab (5 properties). Each schema is shown below with its type and property counts.

PageBeanScreen
object
A page of items.
7 properties
UpdateScreenDetails
object
Details of a screen.
2 properties
ScreenableTab
object
A screen tab.
2 properties 1 required
ScreenWithTab
object
A screen with tab details.
5 properties
ScreenDetails
object
Details of a screen.
2 properties 1 required
ProjectDetails
object
Details about a project.
8 properties
Screen
object
A screen.
4 properties
ScreenableField
object
A screen tab field.
2 properties
PageBeanScreenWithTab
object
A page of items.
7 properties
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
AvatarUrlsBean
object
4 properties
UpdatedProjectCategory
object
A project category.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-screens-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Screens 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.