• Announcement banner
  • App data policies (EAP)
  • Application roles
  • Audit records
  • Avatars
  • Classification levels
  • Dashboards
  • Filters
  • Filter sharing
  • Group and user picker
  • Groups
  • Issues
  • UI modifications (apps)
  • Issue attachments
  • Issue comments
  • Issue comment properties
  • Issue fields
  • Issue field configurations
  • Issue custom field contexts
  • Issue custom field options
  • Issue custom field options (apps)
  • Issue custom field values (apps)
  • Issue custom field configuration (apps)
  • Issue navigator settings
  • Issue notification schemes
  • Issue priorities
  • Issue properties
  • Issue resolutions
  • Issue security level
  • Issue security schemes
  • Issue types
  • Issue type schemes
  • Issue type screen schemes
  • Issue type properties
  • Issue votes
  • Issue watchers
  • Issue worklogs
  • Issue worklog properties
  • Jira expressions
  • Jira settings
  • JQL
  • JQL functions (apps)
  • Labels
  • License metrics
  • Myself
  • Permissions
  • Permission schemes
  • Projects
  • Project avatars
  • Project categories
  • Project classification levels
  • Project components
  • Project email
  • Project features
  • Project key and name validation
  • Project permission schemes
  • Project properties
  • Project roles
  • Project role actors
  • Project types
  • Project versions
  • Screens
  • Screen tabs
  • Screen tab fields
  • Screen schemes
  • Server info
  • Status
  • Tasks
  • Time tracking
  • Users
  • User properties
  • Webhooks
  • Workflows
  • Workflow transition rules
  • Workflow schemes
  • Workflow scheme project associations
  • Workflow scheme drafts
  • Workflow statuses
  • Workflow status categories
  • Workflow transition properties
  • App properties
  • Dynamic modules
  • App migration
  • Service Registry
Cloud
Jira Cloud platform / Reference / REST API v3 (beta)

Screen tabs

Postman Collection
OpenAPI
GET

Get bulk screen tabsExperimental

Returns the list of tabs for a bulk of screens.

Permissions required:

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-project
Granular:read:screen-tab:jira

Request

Query parameters

screenId

array<integer>

tabId

array<integer>

startAt

integer

maxResult

integer

Responses

Returned if the request is successful.

application/json

any

GET/rest/api/3/screens/tabs
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/screens/tabs`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 { "isLast": true, "maxResults": 100, "startAt": 0, "total": 2, "values": [ { "screenId": 10000, "tabId": 10001, "tabName": "My Custom Tab 1" }, { "screenId": 10001, "tabId": 10002, "tabName": "My Custom Tab 2" } ] }
GET

Get all screen tabs

Returns the list of tabs for a screen.

Permissions required:

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-project
Granular:read:screen-tab:jira

Request

Path parameters

screenId

integer

Required

Query parameters

projectKey

string

Responses

Returned if the request is successful.

application/json

array<ScreenableTab>

GET/rest/api/3/screens/{screenId}/tabs
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 [ { "id": 25, "name": "<string>" } ]
POST

Create screen tab

Creates a tab for a screen.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-project
Granular:read:screen-tab:jira, write:screen-tab:jira

Request

Path parameters

screenId

integer

Required

Request bodyapplication/json

name

string

Required

Responses

Returned if the request is successful.

application/json

ScreenableTab

A screen tab.

POST/rest/api/3/screens/{screenId}/tabs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "name": "Fields Tab" }`; const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 { "id": 10000, "name": "Fields Tab" }
PUT

Update screen tab

Updates the name of a screen tab.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-project
Granular:read:screen-tab:jira, write:screen-tab:jira

Request

Path parameters

screenId

integer

Required
tabId

integer

Required

Request bodyapplication/json

name

string

Required

Responses

Returned if the request is successful.

application/json

ScreenableTab

A screen tab.

PUT/rest/api/3/screens/{screenId}/tabs/{tabId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "name": "<string>" }`; const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs/{tabId}`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 { "id": 10000, "name": "Fields Tab" }
DEL

Delete screen tab

Deletes a screen tab.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-project
Granular:delete:screen-tab:jira

Request

Path parameters

screenId

integer

Required
tabId

integer

Required

Responses

Returned if the request is successful.

DEL/rest/api/3/screens/{screenId}/tabs/{tabId}
1 2 3 4 5 6 7 8 9 10 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs/{tabId}`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
POST

Move screen tab

Moves a screen tab.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-project
Granular:write:screen:jira

Request

Path parameters

screenId

integer

Required
tabId

integer

Required
pos

integer

Required

Responses

Returned if the request is successful.

application/json

any

POST/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}
1 2 3 4 5 6 7 8 9 10 11 12 13 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}`, { method: 'POST', headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());

Rate this page: