Atlassian Dashboards API

The Dashboards API from Atlassian — 10 operation(s) for dashboards.

Documentation 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 · Atlassian Get All Dashboards #

Ask an LLM

“How do I list all the Jira dashboards I own or that were shared with me?”

“Can I show only my favorite dashboards?”

Tell an agent

List every dashboard I can see.

Show my dashboards filtered to {filter}.

POST /rest/api/3/dashboard Create a dashboard · Atlassian Create Dashboard #

Ask an LLM

“How do I create a new Jira dashboard and decide who can see and edit it?”

“What sharing and edit permissions does a new dashboard need?”

Tell an agent

Create a dashboard named {name}.

Create dashboard {name} described as {description} with share permissions {sharePermissions} and edit permissions {editPermissions}.

PUT /rest/api/3/dashboard/bulk/edit Bulk edit up to 100 dashboards · Atlassian Bulk Edit Dashboards #

Ask an LLM

“Can I change the owner or permissions of many dashboards at once?”

“What's the limit on how many dashboards a bulk edit can touch?”

Tell an agent

Apply bulk action {action} to dashboards {entityIds}.

Transfer ownership of dashboards {entityIds} using {changeOwnerDetails}.

GET /rest/api/3/dashboard/gadgets List gadgets available for dashboards · Atlassian Get Available Gadgets #

Ask an LLM

“Which gadgets can be added to Jira dashboards on this site?”

“What's the full catalog of dashboard gadgets I can choose from?”

Tell an agent

List all gadgets available to add to dashboards.

Show me the gadget catalog for dashboards.

GET /rest/api/3/dashboard/search Search dashboards by name, owner or group · Atlassian Search For Dashboards #

Ask an LLM

“How do I find dashboards with a particular name?”

“Can I search for dashboards owned by a specific 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 gadgets on a dashboard · Atlassian Get Gadgets #

Ask an LLM

“What gadgets are currently on a given dashboard?”

“Can I look up dashboard gadgets by module key or URI?”

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 · Atlassian Add Gadget To Dashboard #

Ask an LLM

“How do I put a new gadget on a dashboard?”

“Can I set a gadget's color and position when adding it?”

Tell an agent

Add gadget {moduleKey} to dashboard {dashboardId}.

Add a gadget titled {title} in {color} at {position} on dashboard {dashboardId}.

DELETE /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} Remove a gadget from a dashboard · Atlassian 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 one is removed?”

Tell an agent destructive · confirm first

Remove gadget {gadgetId} from dashboard {dashboardId}.

Delete gadget {gadgetId} off dashboard {dashboardId}.

PUT /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId} Change a gadget's title, position or color · Atlassian Update Gadget On Dashboard #

Ask an LLM

“How do I rename or recolor a gadget already on my dashboard?”

“Can I move an existing gadget to another spot on the dashboard?”

Tell an agent

Rename gadget {gadgetId} on dashboard {dashboardId} to {title}.

Move gadget {gadgetId} on dashboard {dashboardId} to {position}.

GET /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties List property keys on a dashboard item · Atlassian Get Dashboard Item Property Keys #

Ask an LLM

“What custom property keys are stored on a dashboard item?”

“Which properties has my app saved against a dashboard gadget item?”

Tell an agent

List property keys for item {itemId} on dashboard {dashboardId}.

Show which properties exist on dashboard {dashboardId} item {itemId}.

DELETE /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} Delete a dashboard item property · Atlassian Delete Dashboard Item Property #

Ask an LLM

“How do I remove a stored property from a dashboard item?”

“Who is allowed to delete dashboard item properties?”

Tell an agent destructive · confirm first

Delete property {propertyKey} from item {itemId} on dashboard {dashboardId}.

Clear the {propertyKey} property off dashboard item {itemId}.

GET /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} Read a dashboard item property · Atlassian Get Dashboard Item Property #

Ask an LLM

“How do I read the value my app stored on a dashboard item?”

“Can I fetch one named property from a dashboard gadget item?”

Tell an agent

Get property {propertyKey} on item {itemId} of dashboard {dashboardId}.

Read the {propertyKey} value from dashboard item {itemId}.

PUT /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} Store a property on a dashboard item · Atlassian Set Dashboard Item Property #

Ask an LLM

“How can my app save custom data against a dashboard item?”

“Can I overwrite an existing dashboard item property value?”

Tell an agent

Set property {propertyKey} on item {itemId} of dashboard {dashboardId}.

Save my app data under {propertyKey} on dashboard item {itemId}.

DELETE /rest/api/3/dashboard/{id} Delete a dashboard · Atlassian Delete Dashboard #

Ask an LLM

“How do I delete a dashboard I own?”

“Can I delete a dashboard 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 dashboard · Atlassian Get Dashboard #

Ask an LLM

“How do I fetch the details of one dashboard by its id?”

“Can I view 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 details · Atlassian Update Dashboard #

Ask an LLM

“How do I rename a dashboard or change who it's shared with?”

“Does updating a dashboard replace all of its details?”

Tell an agent

Rename dashboard {id} to {name}.

Update dashboard {id} to share with {sharePermissions} and allow edits by {editPermissions}.

POST /rest/api/3/dashboard/{id}/copy Copy a dashboard · Atlassian Copy Dashboard #

Ask an LLM

“How do I duplicate an existing dashboard?”

“Can I give the copy of a dashboard a new name and permissions?”

Tell an agent

Copy dashboard {id} as {name}.

Clone dashboard {id} with share permissions {sharePermissions}.

Atlassian Dashboards API

Operations 17

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