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.
Jira Dashboards API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.
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-82b018affa468e58f284fbe4df33536469d757df.
Requests are made against a single base URL, https://your-domain.atlassian.net.
17 operations10 paths51 schemas3 DELETE7 GET3 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Jira Dashboards 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 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.
The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Project (34 properties), Version (19 properties), User (16 properties), ProjectComponent (16 properties). Each schema is shown below with its type and property counts.
ProjectPermissions
object
Permissions which a user has on a project.
1 property
Version
object
Details about a project version.
19 properties
ProjectRoleGroup
object
Details of the group associated with the role.
3 properties
ListWrapperCallbackGroupName
object
Hierarchy
object
The project issue type hierarchy.
2 properties
DashboardGadget
object
Details of a gadget.
6 properties4 required
ProjectRole
object
Details about the roles in a project.
11 properties
IssueTypeDetails
object
Details about an issue type.
10 properties
EntityProperty
object
An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
2 properties
ErrorCollection
object
Error messages from an operation.
3 properties
SimpleLink
object
Details about the operations available in this version.
7 properties
PropertyKeys
object
List of property keys.
1 property
SimplifiedHierarchyLevel
object
9 properties
BulkEditShareableEntityRequest
object
Details of a request to bulk edit shareable entity.
5 properties2 required
ProjectComponent
object
Details about a project component.
16 properties
BulkChangeOwnerDetails
object
Details for changing owners of shareable entities
2 properties2 required
DashboardGadgetUpdateRequest
object
The details of the gadget to update.
3 properties
AvailableDashboardGadgetsResponse
object
The list of available gadgets.
1 property1 required
ProjectCategory
object
A project category.
4 properties
RoleActor
object
Details about a user assigned to a project role.
7 properties
AvailableDashboardGadget
object
The details of the available dashboard gadget.
3 properties1 required
DashboardDetails
object
Details of a dashboard.
4 properties3 required
SimpleListWrapperGroupName
object
5 properties
DashboardGadgetResponse
object
The list of gadgets on the dashboard.
1 property1 required
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…
16 properties
SharePermission
object
Details of a share permission for the filter.
6 properties1 required
BulkEditActionError
object
Errors of bulk edit action.
2 properties2 required
PropertyKey
object
Property key details.
2 properties
UserBeanAvatarUrls
object
4 properties
PermissionDetails
object
Details for permissions of shareable entities
2 properties2 required
PageOfDashboards
object
A page containing dashboard details.
6 properties
Project
object
Details about a project.
34 properties
ListWrapperCallbackApplicationRole
object
ProjectRoleUser
object
Details of the user associated with the role.
1 property
ProjectInsight
object
Additional details about a project.
2 properties
ProjectLandingPageInfo
object
11 properties
AvatarUrlsBean
object
4 properties
Dashboard
object
Details of a dashboard.
14 properties
UserBean
object
7 properties
VersionApprover
object
Contains details about a version approver.
4 properties
DashboardGadgetPosition
object
Details of a gadget position.
2 properties2 required
BulkEditShareableEntityResponse
object
Details of a request to bulk edit shareable entity.
2 properties1 required
GroupName
object
Details about a group.
3 properties
DashboardGadgetSettings
object
Details of the settings for a dashboard gadget.
6 properties
ApplicationRole
object
Details of an application role.
14 properties
VersionIssuesStatus
object
Counts of the number of issues in various statuses.
4 properties
PageBeanDashboard
object
A page of items.
7 properties
ProjectDetails
object
Details about a project.
8 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
UpdatedProjectCategory
object
A project category.
4 properties
SimpleListWrapperApplicationRole
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
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.
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 Jira 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.
