Get dashboard

GET

/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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/dashboard/'

Response Example

200 - Success

{"id":"10000","isFavourite":false,"name":"System Dashboard","popularity":1,"self":"https://your-domain.atlassian.net/rest/api/3/dashboard/10000","sharePermissions":[{"type":"global"}],"view":"https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000"}

Request

Path Params

Responses

🟢200Returned if the request is successful.

application/json

Body

🟠400400 response

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if the dashboard is not found or the dashboard is not owned by or shared with the user.

Modified at 2023-07-13 03:27:27

Delete dashboard item property

Update dashboard