# Jira Dashboards API

**Canonical:** https://apis.io/apis/jira/jira-dashboards-api/  
**Provider:** Jira — https://apis.io/providers/jira/  
**Base URL:** https://your-domain.atlassian.net/rest/api/2  
**Documentation:** https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/

Jira Dashboards API is one of 132 APIs that [Jira](https://apis.io/providers/jira/) publishes on the [APIs.io](https://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 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.

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| GET | `/rest/api/3/dashboard` | Get all dashboards |
| POST | `/rest/api/3/dashboard` | Create dashboard |
| PUT | `/rest/api/3/dashboard/bulk/edit` | Bulk edit dashboards |
| GET | `/rest/api/3/dashboard/gadgets` | Get available gadgets |
| GET | `/rest/api/3/dashboard/search` | Search for dashboards |
| GET | `/rest/api/3/dashboard/{dashboardId}/gadget` | Get gadgets |
| POST | `/rest/api/3/dashboard/{dashboardId}/gadget` | Add gadget to dashboard |
| DELETE | `/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}` | Remove gadget from dashboard |
| PUT | `/rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}` | Update gadget on dashboard |
| GET | `/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties` | Get dashboard item property keys |
| DELETE | `/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}` | Delete dashboard item property |
| GET | `/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}` | Get dashboard item property |
| PUT | `/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}` | Set dashboard item property |
| DELETE | `/rest/api/3/dashboard/{id}` | Delete dashboard |
| GET | `/rest/api/3/dashboard/{id}` | Get dashboard |
| PUT | `/rest/api/3/dashboard/{id}` | Update dashboard |
| POST | `/rest/api/3/dashboard/{id}/copy` | Copy dashboard |

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-dashboards-api-openapi.yml
- **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/

## Other Jira APIs (12)

- [Jira Cloud Platform REST API v2](https://apis.io/apis/jira/jira-cloud-platform-rest-api-v2/)
- [Jira Service Management Operations REST API](https://apis.io/apis/jira/jira-service-management-operations-rest-api/)
- [Jira Align REST API](https://apis.io/apis/jira/jira-align-rest-api/)
- [Jira Customer Service Management REST API](https://apis.io/apis/jira/jira-customer-service-management-rest-api/)
- [Jira Issue Comments API](https://apis.io/apis/jira/jira-issue-comments-api/)
- [Jira Issue Priorities API](https://apis.io/apis/jira/jira-issue-priorities-api/)
- [Jira Issue Search API](https://apis.io/apis/jira/jira-issue-search-api/)
- [Jira Issue Statuses API](https://apis.io/apis/jira/jira-issue-statuses-api/)
- [Jira Issue Transitions API](https://apis.io/apis/jira/jira-issue-transitions-api/)
- [Jira Issue Types API](https://apis.io/apis/jira/jira-issue-types-api/)
- [Jira Issues API](https://apis.io/apis/jira/jira-issues-api/)
- [Jira Projects API](https://apis.io/apis/jira/jira-projects-api/)

## Tags

Dashboards

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/jira/jira-dashboards-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/jira/.
