ThingsBoard icon

ThingsBoard

Interact with ThingsBoard REST API

Dashboard → Get Customer Dashboards

AI-generated

Summary

Fetch customer dashboards

Inputs

  • customerIdRequired (required) — A string value representing the customer ID. For example, "784f394c-42b6-435a-983c-b7beff2784f9".
  • pageSize — Maximum amount of entities in a one page
  • page — Sequence number of page starting from 0
  • sortOrder — Sort order. ASC (ASCENDING) or DESC (DESCENDING).
  • dashboardTextSearch — The case insensitive "substring" filter based on the dashboard title
  • dashboardSortProperty — Property of entity to sort by
  • includeCustomers — Whether to include customer or sub-customer entities

Output shape

array of dashboard objects

Optionally includes customer/sub-customer entities when includeCustomers is true; pagination is controlled via pageSize and page; errors are returned as node errors.

Examples

Example 1: Get dashboards for a specific customer

customerIdRequired=784f394c-42b6-435a-983c-b7beff2784f9&pageSize=10&page=0&sortOrder=DESC

Example 2: Search dashboards by title

dashboardTextSearch=Warehouse&dashboardSortProperty=title&includeCustomers=false

Example 3: Retrieve first page of dashboards with customer sub-entities

customerIdRequired=784f394c-42b6-435a-983c-b7beff2784f9&pageSize=5&page=0&includeCustomers=true

Links

Discussion