ThingsBoard icon

ThingsBoard

Interact with ThingsBoard REST API

Dashboard → Get User Dashboards

AI-generated

Summary

Retrieve a paginated list of dashboards accessible to the current user.

Inputs

  • pageSize — Maximum number of dashboards to return per page; defaults to 10.
  • page — Page number to retrieve, starting from 0; defaults to 0.
  • sortOrder — Sort order for dashboards; either "ASC" or "DESC", defaults to "DESC".
  • dashboardTextSearch — Case‑insensitive substring to filter dashboards by title; optional.
  • dashboardSortProperty — Property used for sorting dashboards; either "createdTime" or "title", defaults to "createdTime".
  • isMobileDashboard — If true, excludes dashboards hidden for mobile; defaults to false.
  • dashboardOperation — Filter dashboards by allowed operation for the current user; optional.
  • userId — User ID to impersonate; optional, used for multi‑tenant scenarios.

Output shape

array of dashboard summary objects

Pagination metadata may be included; response fields are optional and vary by ThingsBoard version; operation fails with an error if authentication or required parameters are missing.

Examples

Example 1: Fetch the first page of dashboards visible to the current user with default sorting.

resource=Dashboard, operation=Get User Dashboards, page=0, pageSize=10

Example 2: Search dashboards by title substring and sort by title ascending.

dashboardTextSearch=example, dashboardSortProperty=title, sortOrder=ASC

Example 3: Get mobile‑excluded dashboards filtered by a specific operation.

isMobileDashboard=true, dashboardOperation=getReports

Links

Discussion