Read dashboards

GET

/domains/{domain}/users/{user}/dashboards

Last modified:2026-10-05 17:54:10

OperationId:ReadDashboards

Returns the dashboards your token sees in the domain, with their layouts and sharing settings, and whether you marked each one a favorite or hid it.

Requires a token that can read dashboards for the user in the path: the user itself, or Office Manager scope or higher for the domain.

The user in the path is not used to choose the dashboards: the result is always what your own token sees, including dashboards you hid. Filter by id for one dashboard: an ID that is not in this domain returns 404, and one you cannot see returns 403. For another user's dashboards, use GET /domains/{domain}/users/{user}/dashboards/list.

Send only the filters listed here. A query-builder key such as OR or joins, or a filter name that is not a plain field name, returns 400.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200OK

application/json

The dashboards your token sees. An empty array when there are none.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Record not found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/example.com/users/1001/dashboards?id=42&owner_id=1001&share_type=domain&limit=undefined&start=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - One dashboard

[
    {
        "id": 42,
        "name": "Support Queue Overview",
        "description": "Live view of the support queues.",
        "domain": "example.com",
        "properties": "{\"theme\":\"dark\"}",
        "layouts": "{\"lg\":[{\"i\":\"63\",\"x\":0,\"y\":0,\"w\":6,\"h\":4}]}",
        "owner_type": 1,
        "owner_id": "1001",
        "status": 1,
        "share_type": "select",
        "share_details": "[{\"type\":\"scope\",\"value\":\"Call Center Supervisor\"}]",
        "public_id": null,
        "created": "2026-08-14T09:00:00+00:00",
        "last-modified-datetime": "2026-09-01T14:30:00+00:00",
        "favorite": true,
        "hide": false
    }
]

Modified at 2026-10-05 17:54:10

List user dashboards

Create dashboard