---
title: "Get Home Dashboard Info (getHomeDashboardInfo)"
method: GET
path: "/api/dashboard/home/info"
tags: ["dashboard-controller"]
---

# Get Home Dashboard Info (getHomeDashboardInfo)

`GET /api/dashboard/home/info`

Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the User. If 'homeDashboardId' parameter is not set on the User level and the User has authority 'CUSTOMER_USER', check the same parameter for the corresponding Customer. If 'homeDashboardId' parameter is not set on the User and Customer levels then checks the same parameter for the Tenant that owns the user. 

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

## Response `200`

OK

- HomeDashboardInfo — A JSON object that represents home dashboard id and other parameters
  - `dashboardId` DashboardId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'DASHBOARD', required — string
  - `hideDashboardToolbar` boolean — Hide dashboard toolbar flag. Useful for rendering dashboards on mobile.

---

[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)