---
title: "Get Widget Bundle (getWidgetsBundleById)"
method: GET
path: "/api/widgetsBundle/{widgetsBundleId}"
tags: ["widgets-bundle-controller"]
---

# Get Widget Bundle (getWidgetsBundleById)

`GET /api/widgetsBundle/{widgetsBundleId}`

Get the Widget Bundle based on the provided Widget Bundle Id. Widget Bundle represents a group(bundle) of widgets. Widgets are grouped into bundle by type or use case. 

Available for any authorized user.

## Path parameters

- `widgetsBundleId` string, required

## Query parameters

- `inlineImages` boolean

## Response `200`

OK

- WidgetsBundle — A JSON value representing the Widget Bundle.
  - `id` WidgetsBundleId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'WIDGETS_BUNDLE', required — string
  - `createdTime` integer — Timestamp of the Widget Bundle creation, in milliseconds
  - `tenantId` TenantId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'TENANT', required — string
  - `alias` string — Unique alias that is used in widget types as a reference widget bundle
  - `title` string — Title used in search and UI
  - `image` string — Relative or external image URL. Replaced with image data URL (Base64) in case of relative URL and 'inlineImages' option enabled.
  - `scada` boolean — Whether widgets bundle contains SCADA symbol widget types.
  - `description` string — Description
  - `order` integer — Order
  - `version` integer
  - `name` string — Same as title of the Widget Bundle. Read-only field. Update the 'title' to change the 'name' of the Widget Bundle.

---

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