---
title: "Retrieve a widget"
method: GET
path: "/api/widgets/{id}"
tags: ["Widgets"]
---

# Retrieve a widget

`GET /api/widgets/{id}`

## Path parameters

- `id` integer, required

## Response `200`

The requested widget.

- Widget — A widget is a container that can be used to display customized data coming from integrations at the right-hand sidebar of the [ticket](#the-ticket-object) or user page. It contains a list of fields and values that come from integrations.
  - `id` integer — ID of the widget.
  - `context` 'ticket' | 'customer' | 'user' — The context to display this widget in. Supported values are: `ticket`, `customer`, `user`. The value <span style={{color: 'red'}}>`user` has been deprecated</span>, please use `customer` instead.
  - `created_datetime` string, date-time — When the widget was created.
  - `deactivated_datetime` string, date-time, nullable — When the widget was deactivated.
  - `integration_id` integer, nullable — ID of the integration that the widget's data is attached to. Only used for widgets attached to HTTP integrations. Widgets are the same for all Shopify integrations, but each HTTP integration needs a specific widget.
  - `app_id` string, nullable — The ID of the 3rd party app that the widget's data is attached to. Used for customer external data widgets.
  - `order` integer — Order of precedence of the widget. Widgets with lower order are shown first.
  - `template` object — Template to render the data of the widget.
  - `type` 'bigcommerce' | 'custom' | 'customer_external_data' | 'http' | 'magento2' | 'recharge' | 'shopify' | 'smile' | 'standalone' | 'yotpo' | 'klaviyo' | 'stripe' | 'woocommerce' — Type of data the widget is attached to.
  - `updated_datetime` string, date-time — When the widget was updated.
  - `uri` string — URI of the widget.

---

[API](https://skmtc.net/gorgias/apis/gorgias-rest-api.md) · [All operations](https://skmtc.net/gorgias/apis/gorgias-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gorgias/gorgias-rest-api/versions/36f2e31f4e81/schema)