Actions60
- Alarm Actions
- Asset Actions
- Customer Actions
- Dashboard Actions
- Device Actions
- Entity Group Actions
- Relation Actions
- Telemetry Actions
Dashboard → Get Dashboards
AI-generatedSummary
Fetch a paginated list of dashboards, optionally filtered and sorted.
Inputs
- authentication — Authentication method to use: either API Key or Username/Password.
- pageSize — Maximum amount of entities per page; default 10.
- page — Page number, starting from 0; default 0.
- sortOrder — Sort order: ASC or DESC; default DESC.
- dashboardTextSearch — Case‑insensitive substring filter on dashboard title.
- dashboardSortProperty — Property used for sorting dashboards; default createdTime.
- isMobileDashboard — When true, excludes dashboards hidden for mobile.
Output shape
a page of dashboard objects
Result is paginated; may include metadata such as total count. The response body is a JSON array of dashboard summaries, optionally filtered by mobile flag and search parameters.
Examples
Example 1: Fetch the first page of dashboards sorted by createdTime descending, using API Key authentication.
resource=dashboard, operation=Get Dashboards, page=0, pageSize=10, sortOrder=DESC, authentication=apiKey
Example 2: Search dashboards containing the term "home" and return only mobile‑compatible dashboards.
resource=dashboard, operation=Get Dashboards, dashboardTextSearch=home, isMobileDashboard=true, authentication=apiKey