Get all dashboards
GET
/rest/api/3/dashboard
Dashboards
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/dashboard'
Response Response Example
200 - Success
{
"startAt": 10,
"maxResults": 10,
"total": 143,
"prev": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=0",
"next": "https://your-domain.atlassian.net/rest/api/3/dashboard?startAt=10",
"dashboards": [
{
"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"
},
{
"id": "20000",
"isFavourite": true,
"name": "Build Engineering",
"owner": {
"key": "Mia",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"name": "mia",
"displayName": "Mia Krystof",
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
}
},
"popularity": 1,
"self": "https://your-domain.atlassian.net/rest/api/3/dashboard/20000",
"sharePermissions": [
{
"id": 10105,
"type": "group",
"group": {
"name": "administrators",
"self": "https://your-domain.atlassian.net/rest/api/3/group?groupname=administrators"
}
}
],
"view": "https://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=20000"
}
]
}
Request
Query Params
filter
string
optional
favourite
Returns dashboards the user has marked as favorite.my
Returns dashboards owned by the user.startAt
integer
optional
maxResults
integer
optional
Responses
Modified at 2023-07-13 03:27:27