---
title: "Get Customer Dashboards (getCustomerDashboards)"
method: GET
path: "/api/customer/{customerId}/dashboards"
tags: ["dashboard-controller"]
---

# Get Customer Dashboards (getCustomerDashboards)

`GET /api/customer/{customerId}/dashboards`

Returns a page of dashboard info objects owned by the specified customer. The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. 

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

## Path parameters

- `customerId` string, required

## Query parameters

- `pageSize` integer, required
- `page` integer, required
- `mobile` boolean
- `textSearch` string
- `sortProperty` 'createdTime' | 'title'
- `sortOrder` 'ASC' | 'DESC'

## Response `200`

OK

- PageDataDashboardInfo
  - `data` DashboardInfo[] — Array of the entities
    - `id` DashboardId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'DASHBOARD', required — string
    - `createdTime` integer — Timestamp of the dashboard creation, in milliseconds
    - `tenantId` TenantId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT', required — string
    - `title` string, required — Title of the dashboard.
    - `image` string — Thumbnail picture for rendering of the dashboards in a grid view on mobile devices.
    - `assignedCustomers` ShortCustomerInfo[] — List of assigned customers with their info.
      - `customerId` CustomerId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'CUSTOMER', required — string
      - `title` string — Title of the customer.
      - `isPublic` boolean
      - `public` boolean
    - `mobileHide` boolean — Hide dashboard from mobile devices. Useful if the dashboard is not designed for small screens.
    - `mobileOrder` integer — Order on mobile devices. Useful to adjust sorting of the dashboards for mobile applications
    - `version` integer
    - `name` string — Same as title of the dashboard. Read-only field. Update the 'title' to change the 'name' of the dashboard.
  - `totalPages` integer — Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria
  - `totalElements` integer — Total number of elements in all available pages
  - `hasNext` boolean — 'false' value indicates the end of the result set

---

[API](https://skmtc.net/thingsboard/apis/thingsboard-rest-api.md) · [All operations](https://skmtc.net/thingsboard/apis/thingsboard-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thingsboard/thingsboard-rest-api/revisions/40169ccdec5c/schema)