---
title: "Get Widget Type Details (getWidgetTypeById)"
method: GET
path: "/api/widgetType/{widgetTypeId}"
tags: ["widget-type-controller"]
---

# Get Widget Type Details (getWidgetTypeById)

`GET /api/widgetType/{widgetTypeId}`

Get the Widget Type Details based on the provided Widget Type Id. Widget Type Details extend Widget Type and add image and description properties. Those properties are useful to edit the Widget Type but they are not required for Dashboard rendering. 

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

## Path parameters

- `widgetTypeId` string, required

## Query parameters

- `includeResources` boolean

## Response `200`

OK

- WidgetTypeDetails — A JSON value representing the Widget Type Details.
  - `fqn` string — Unique FQN that is used in dashboards as a reference widget type
  - `name` string — Widget name used in search and UI
  - `deprecated` boolean — Whether widget type is deprecated.
  - `image` string — Relative or external image URL. Replaced with image data URL (Base64) in case of relative URL and 'inlineImages' option enabled.
  - `description` string — Description of the widget
  - `descriptor` unknown
  - `resources` ResourceExportData[]
    - `link` string
    - `title` string
    - `type` 'LWM2M_MODEL' | 'JKS' | 'PKCS_12' | 'JS_MODULE' | 'IMAGE' | 'DASHBOARD' | 'GENERAL'
    - `subType` 'IMAGE' | 'SCADA_SYMBOL' | 'EXTENSION' | 'MODULE'
    - `resourceKey` string
    - `fileName` string
    - `publicResourceKey` string
    - `isPublic` boolean
    - `mediaType` string
    - `data` string
    - `public` boolean
  - `id` WidgetTypeId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'WIDGET_TYPE', required — string
  - `createdTime` integer — Timestamp of the Widget Type creation, in milliseconds
  - `tenantId` TenantId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'TENANT', required — string
  - `scada` boolean — Whether widget type is SCADA symbol.
  - `version` integer
  - `tags` string[] — Tags of the widget type

---

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