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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Atlassian

Atlassian Dashboards API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Atlassian Dashboards API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 17 operations across 10 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.

Requests are made against a single base URL, https://your-domain.atlassian.net.

17 operations 10 paths 51 schemas 3 DELETE7 GET3 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
Contact
ecosystem@atlassian.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Atlassian Dashboards API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 17

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

Dashboards 17

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.

GET
/rest/api/3/dashboard
Atlassian Get All Dashboards
atlassianGetalldashboards 3 params → 200400401
POST
/rest/api/3/dashboard
Atlassian Create Dashboard
atlassianCreatedashboard body → 200400401
PUT
/rest/api/3/dashboard/bulk/edit
Atlassian Bulk Edit Dashboards
atlassianBulkeditdashboards body → 200400401
GET
/rest/api/3/dashboard/gadgets
Atlassian Get Available Gadgets
atlassianGetallavailabledashboardgadgets → 200400401
GET
/rest/api/3/dashboard/search
Atlassian Search For Dashboards
atlassianGetdashboardspaginated 11 params → 200400401
GET
/rest/api/3/dashboard/{dashboardId}/gadget
Atlassian Get Gadgets
atlassianGetallgadgets 4 params → 200401404
POST
/rest/api/3/dashboard/{dashboardId}/gadget
Atlassian Add Gadget To Dashboard
atlassianAddgadget 1 param body → 200400401404
DELETE
/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
Atlassian Remove Gadget From Dashboard
atlassianRemovegadget 2 params → 204401404
PUT
/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
Atlassian Update Gadget On Dashboard
atlassianUpdategadget 2 params body → 204400401404
GET
/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties
Atlassian Get Dashboard Item Property Keys
atlassianGetdashboarditempropertykeys 2 params → 200401404
DELETE
/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
Atlassian Delete Dashboard Item Property
atlassianDeletedashboarditemproperty 3 params → 204400401403404
GET
/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
Atlassian Get Dashboard Item Property
atlassianGetdashboarditemproperty 3 params → 200401404
PUT
/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
Atlassian Set Dashboard Item Property
atlassianSetdashboarditemproperty 3 params body → 200201400401403404
DELETE
/rest/api/3/dashboard/{id}
Atlassian Delete Dashboard
atlassianDeletedashboard 1 param → 204400401
GET
/rest/api/3/dashboard/{id}
Atlassian Get Dashboard
atlassianGetdashboard 1 param → 200400401404
PUT
/rest/api/3/dashboard/{id}
Atlassian Update Dashboard
atlassianUpdatedashboard 1 param body → 200400401404
POST
/rest/api/3/dashboard/{id}/copy
Atlassian Copy Dashboard
atlassianCopydashboard 1 param body → 200400401404

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Project (34 properties), Version (19 properties), ProjectComponent (16 properties), ApplicationRole (14 properties). Each schema is shown below with its type and property counts.

UserBeanAvatarUrls
object
4 properties
ProjectPermissions
object
Permissions which a user has on a project.
1 property
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
ProjectRoleUser
object
Details of the user associated with the role.
1 property
DashboardGadgetSettings
object
Details of the settings for a dashboard gadget.
6 properties
UpdatedProjectCategory
object
A project category.
4 properties
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
AvailableDashboardGadget
object
The details of the available dashboard gadget.
3 properties 1 required
SimplifiedHierarchyLevel
object
9 properties
Project
object
Details about a project.
34 properties
BulkEditActionError
object
Errors of bulk edit action.
2 properties 2 required
BulkChangeOwnerDetails
object
Details for changing owners of shareable entities
2 properties 2 required
ProjectInsight
object
Additional details about a project.
2 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
Dashboard
object
Details of a dashboard.
14 properties
EntityProperty
object
An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
2 properties
VersionApprover
object
Contains details about a version approver.
4 properties
ProjectRole
object
Details about the roles in a project.
11 properties
ErrorCollection
object
Error messages from an operation.
3 properties
GroupName
object
Details about a group.
3 properties
VersionIssuesStatus
object
Counts of the number of issues in various statuses.
4 properties
DashboardDetails
object
Details of a dashboard.
4 properties 3 required
DashboardGadgetPosition
object
Details of a gadget position.
2 properties 2 required
Hierarchy
object
The project issue type hierarchy.
2 properties
DashboardGadgetResponse
object
The list of gadgets on the dashboard.
1 property 1 required
SimpleListWrapperGroupName
object
5 properties
ListWrapperCallbackApplicationRole
object
DashboardGadgetUpdateRequest
object
The details of the gadget to update.
3 properties
ProjectComponent
object
Details about a project component.
16 properties
SharePermission
object
Details of a share permission for the filter.
6 properties 1 required
BulkEditShareableEntityRequest
object
Details of a request to bulk edit shareable entity.
5 properties 2 required
AvailableDashboardGadgetsResponse
object
The list of available gadgets.
1 property 1 required
PageOfDashboards
object
A page containing dashboard details.
6 properties
PermissionDetails
object
Details for permissions of shareable entities
2 properties 2 required
ProjectDetails
object
Details about a project.
8 properties
ApplicationRole
object
Details of an application role.
14 properties
User
object
A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: User record deleted from Atlassian: T…
14 properties
PropertyKeys
object
List of property keys.
1 property
RoleActor
object
Details about a user assigned to a project role.
7 properties
AvatarUrlsBean
object
4 properties
BulkEditShareableEntityResponse
object
Details of a request to bulk edit shareable entity.
2 properties 1 required
ProjectCategory
object
A project category.
4 properties
PropertyKey
object
Property key details.
2 properties
DashboardGadget
object
Details of a gadget.
6 properties 4 required
ListWrapperCallbackGroupName
object
ProjectLandingPageInfo
object
11 properties
SimpleListWrapperApplicationRole
object
5 properties
IssueTypeDetails
object
Details about an issue type.
10 properties
Version
object
Details about a project version.
19 properties
PageBeanDashboard
object
A page of items.
7 properties
UserBean
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-dashboards-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
AE Profile APIs.io
Atlassian Jira Software Board API
AE Profile APIs.io
Atlassian Jira Software Epic API
AE Profile APIs.io
Atlassian Jira Software Sprint API
AE Profile APIs.io
Atlassian Jira Software Development Information API
AE Profile APIs.io
Atlassian Jira Software Feature Flags API
AE Profile APIs.io
Atlassian Jira Software Deployments API
AE Profile APIs.io
Atlassian Jira Software Builds API
AE Profile APIs.io
Atlassian Jira Software Remote Links API
AE Profile APIs.io
Atlassian Jira Software Security Information API
AE Profile APIs.io
Atlassian Jira Service Management Customer API
AE Profile APIs.io
Atlassian Jira Service Management Info API
AE Profile APIs.io
#Dashboards
← Back to A APIs
API Details
ID
atlassian:atlassian-dashboards-api
Server
https://your-domain.atlassian.net
Docs
https://developer.atlassian.com/cloud/bitbucket/rest/api-group-addon/#api-group-addon
Provider
Atlassian
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=atlassian-dashboards-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/atlassian-dashboards-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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