Jira

Jira Dashboards API

This resource represents dashboards. Use it to obtain the details of dashboards as well as get, create, update, or remove item properties and gadgets from dashboards.

GitHub OpenAPI

Operations 17

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/dashboard List dashboards I own or that are shared with me · Get all dashboards #
Ask an LLM
“Which Jira dashboards do I own or have shared with me?”
“Can I list only my favorite dashboards?”
Tell an agent
List all the dashboards I own or can see.
Show my {filter} dashboards, starting at result {startAt}.
POST /rest/api/3/dashboard Create a new dashboard · Create dashboard #
Ask an LLM
“How do I create a new dashboard with its own share and edit permissions?”
“What do I need to supply to set up a brand new dashboard?”
Tell an agent
Create a dashboard named {name} shared as {sharePermissions} and editable by {editPermissions}.
Make a new dashboard called {name} with the description {description}, editable by {editPermissions} and shared as {sharePermissions}.
PUT /rest/api/3/dashboard/bulk/edit Change owner or permissions on many dashboards · Bulk edit dashboards #
Ask an LLM
“Can I change the owner of up to 100 dashboards in one request?”
“Is there a way to update sharing permissions on lots of dashboards at once?”
Tell an agent
Apply the bulk action {action} to dashboards {entityIds}.
Transfer ownership of dashboards {entityIds} using action {action} with owner details {changeOwnerDetails}.
GET /rest/api/3/dashboard/gadgets List gadgets that can be added to dashboards · Get available gadgets #
Ask an LLM
“What gadgets are available to add to a dashboard?”
“Which gadget types does my site offer for dashboards?”
Tell an agent
List every gadget I could add to a dashboard.
Show the catalog of available dashboard gadgets.
GET /rest/api/3/dashboard/search Search dashboards by name, owner, group or project · Search for dashboards #
Ask an LLM
“How do I find a dashboard by its name?”
“Can I search for dashboards owned by a particular user or shared with a group?”
Tell an agent
Search dashboards named {dashboardName}.
Find dashboards owned by account {accountId}, sorted by {orderBy}.
GET /rest/api/3/dashboard/{dashboardId}/gadget List the gadgets on a dashboard · Get gadgets #
Ask an LLM
“Which gadgets are currently on my dashboard?”
“Can I filter a dashboard's gadgets by module key or gadget ID?”
Tell an agent
List the gadgets on dashboard {dashboardId}.
Show gadgets with module key {moduleKey} on dashboard {dashboardId}.
POST /rest/api/3/dashboard/{dashboardId}/gadget Add a gadget to a dashboard · Add gadget to dashboard #
Ask an LLM
“How do I put a new gadget on a dashboard?”
“Can I choose the color and position when adding a gadget?”
Tell an agent
Add the gadget with module key {moduleKey} to dashboard {dashboardId}.
Add a {color} gadget titled {title} from {uri} to dashboard {dashboardId}.
DELETE /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} Remove a gadget from a dashboard · Remove gadget from dashboard #
Ask an LLM
“How do I take a gadget off a dashboard?”
“What happens to the other gadgets in the column when I remove one?”
Tell an agent destructive · confirm first
Remove gadget {gadgetId} from dashboard {dashboardId}.
Delete the gadget {gadgetId} sitting on dashboard {dashboardId}.
PUT /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} Change a gadget's title, position or color · Update gadget on dashboard #
Ask an LLM
“Can I rename a gadget that's already on a dashboard?”
“How do I move or recolor an existing dashboard gadget?”
Tell an agent
Rename gadget {gadgetId} on dashboard {dashboardId} to {title}.
Change gadget {gadgetId} on dashboard {dashboardId} to color {color} at position {position}.
GET /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties List property keys stored on a dashboard item · Get dashboard item property keys #
Ask an LLM
“Which property keys has my app stored on a dashboard item?”
“Can I see all the custom property names set on a dashboard gadget item?”
Tell an agent
List the property keys on item {itemId} of dashboard {dashboardId}.
Show which properties exist for dashboard {dashboardId} item {itemId}.
DELETE /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} Delete a property from a dashboard item · Delete dashboard item property #
Ask an LLM
“How do I remove a stored property from a dashboard item?”
“What permission do I need to delete a dashboard item property?”
Tell an agent destructive · confirm first
Delete property {propertyKey} from item {itemId} on dashboard {dashboardId}.
Clear the {propertyKey} property off dashboard {dashboardId} item {itemId}.
GET /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} Read one property value on a dashboard item · Get dashboard item property #
Ask an LLM
“How do I read the value my app stored under a key on a dashboard item?”
“What value does a given property hold on a dashboard gadget item?”
Tell an agent
Get property {propertyKey} from item {itemId} on dashboard {dashboardId}.
Read the value of {propertyKey} for dashboard {dashboardId} item {itemId}.
PUT /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} Store custom data on a dashboard item · Set dashboard item property #
Ask an LLM
“Can my app save custom data against a dashboard gadget item?”
“How do I set or overwrite a property value on a dashboard item?”
Tell an agent
Set property {propertyKey} on item {itemId} of dashboard {dashboardId}.
Save a value under key {propertyKey} for dashboard {dashboardId} item {itemId}.
DELETE /rest/api/3/dashboard/{id} Delete a dashboard · Delete dashboard #
Ask an LLM
“How do I delete a dashboard I no longer need?”
“Can I delete a dashboard that someone else owns?”
Tell an agent destructive · confirm first
Delete dashboard {id}.
Permanently remove my dashboard {id}.
GET /rest/api/3/dashboard/{id} Get a single dashboard's details · Get dashboard #
Ask an LLM
“How do I look up one specific dashboard by its ID?”
“Can I fetch a dashboard that someone shared with me?”
Tell an agent
Get dashboard {id}.
Show me the details of dashboard {id}.
PUT /rest/api/3/dashboard/{id} Replace a dashboard's name, description and permissions · Update dashboard #
Ask an LLM
“How do I rename a dashboard I own?”
“Does updating a dashboard replace all of its details, including sharing?”
Tell an agent
Rename dashboard {id} to {name}, keeping share permissions {sharePermissions} and edit permissions {editPermissions}.
Update dashboard {id} with description {description}, name {name}, share {sharePermissions}, edit {editPermissions}.
POST /rest/api/3/dashboard/{id}/copy Copy an existing dashboard · Copy dashboard #
Ask an LLM
“Can I duplicate an existing dashboard under a new name?”
“How do I clone a dashboard that's shared with me?”
Tell an agent
Copy dashboard {id} as {name}, shared as {sharePermissions} and editable by {editPermissions}.
Duplicate dashboard {id} into a new one called {name} with edit {editPermissions} and share {sharePermissions}.

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


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