Lists all dashboards of your DESK environment, regardless of access rights in the UI.
The request produces an application/json payload.
| Method | Environment | API Endpoint |
|---|---|---|
| GET | Managed DESK for Government | https://{your-domain}/e/{your-environment-id}/api/config/v1/dashboards |
| GET | Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/dashboards |
To execute this request, you need an access token with ReadConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| owner | string | The owner of the dashboard. | query | optional |
| tags | string[] | A list of tags applied to the dashboard. The dashboard must match all the specified tags. |
query | optional |
| Code | Type | Description |
|---|---|---|
| 200 | DashboardList | Success |
A list of short representations of dashboards.
| Element | Type | Description |
|---|---|---|
| dashboards | DashboardStub[] | A list of short representations of dashboards. |
A short representation of a dashboard.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the dashboard. |
| name | string | The name of the dashboard. |
| owner | string | The owner of the dashboard. |
{
"dashboards": [
{
"id": "d6740373-ff26-4681-b95f-fd5b858c97f7",
"name": "Home dashboard",
"owner": "admin"
},
{
"id": "54b34dbb-2ae7-4c27-9dbc-90a4f4c68b10",
"name": "Databases",
"owner": "viewer"
},
{
"id": "8525b0bf-e33c-4a92-a534-9dedc1391e10",
"name": "Business value",
"owner": "rocks"
}
]
}
In this example, the request lists all dashboards of the mySampleEnv environment.
The API token is passed in the Authorization header.
The result is truncated to three entries.
https://mySampleEnv.live.desk.com/api/config/v1/dashboards \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
https://mySampleEnv.live.desk.com/api/config/v1/dashboards
{
"dashboards": [
{
"id": "891f3203-9953-4796-aacd-886c0f59dddf",
"name": "Home",
"owner": "admin.user"
},
{
"id": "2768e6ca-e199-4433-9e0d-2922aec2099b",
"name": "Sample dashboard",
"owner": "john.smith"
},
{
"id": "1d7d34c6-0eb1-4131-8d29-9022f8e7f530",
"name": "Kubernetes metrics",
"owner": "jane.brown"
}
]
}
200