Get dashboard

https://your-domain.atlassian.net/rest/api/3/dashboard/{id}

Returns a dashboard. This operation can be accessed anonymously. **Permissions required:** None. However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the *Administer Jira* global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

Access Token Required: API Key

Path Parameters

idstringrequired

The ID of the dashboard.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

curl --request GET \
     --url 'https://your-domain.atlassian.net/rest/api/3/dashboard/{id}' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Response

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

GET