---
title: "Get Widget Bundles (getWidgetsBundles)"
method: GET
path: "/api/widgetsBundles"
tags: ["widgets-bundle-controller"]
---

# Get Widget Bundles (getWidgetsBundles)

`GET /api/widgetsBundles`

Returns a page of Widget Bundle objects available for current user. Widget Bundle represents a group(bundle) of widgets. Widgets are grouped into bundle by type or use case.  You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details. 

Available for any authorized user.

## Query parameters

- `widgetsBundleIds` string[], required
- `pageSize` integer, required
- `page` integer, required
- `textSearch` string
- `sortProperty` 'createdTime' | 'title' | 'tenantId'
- `sortOrder` 'ASC' | 'DESC'
- `tenantOnly` boolean
- `fullSearch` boolean
- `scadaFirst` boolean

## Response `200`

OK

- union
  - PageDataWidgetsBundle
    - `data` WidgetsBundle[] — Array of the entities
      - `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.
    - `totalPages` integer — Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria
    - `totalElements` integer — Total number of elements in all available pages
    - `hasNext` boolean — 'false' value indicates the end of the result set
  - WidgetsBundle[]
    - `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)