---
title: "Retrieve details of a specific widget."
method: GET
path: "/canvases/widgets/{id}"
tags: ["Canvases"]
---

# Retrieve details of a specific widget.

`GET /canvases/widgets/{id}`

Retrieve details of a specific widget.

## Path parameters

- `id` string, required

## Response `200`

- Widget — A serializer that conditionally includes optional fields based on context. Optional fields should be listed in `Meta.read_optional_fields`. To include them in the output, pass a list via `context['include_fields']` (for top-level serializers) or `context[<nested_path>]['include_fields']` (for nested serializers). Examples: class ChildSerializer(IncludeOptionalFieldsSerializerMixin, serializers.ModelSerializer): extra = serializers.CharField() class Meta: model = Child fields = ['id', 'extra'] read_optional_fields = ['extra'] class ParentSerializer(IncludeOptionalFieldsSerializerMixin, serializers.ModelSerializer): child = ChildSerializer() expensive = serializers.CharField() class Meta: model = Parent fields = ['id', 'child', 'expensive'] read_optional_fields = ['expensive'] # Top-level usage (includes 'expensive' field) ParentSerializer(instance, context={'include_fields': ['expensive']}).data # Nested usage (includes 'extra' field inside child) ParentSerializer( instance, context={'child': {'include_fields': ['extra']}} ).data
  - `id` string, uuid, required
  - `name` string, required
  - `type` 'RANGE' | 'TEMPLATE' | 'TEXT', required — * `RANGE` - Range * `TEMPLATE` - Template * `TEXT` - Text
  - `visual_type` 'TEXT' | 'DATA_TABLE' | 'LINE' | 'BAR' | 'ROW' | 'COMBO' | 'PIE' | 'DONUT' | 'METRIC' | 'TREND' | 'WATERFALL', required — * `TEXT` - Text * `DATA_TABLE` - Data Table * `LINE` - Line Chart * `BAR` - Bar Chart * `ROW` - Row Chart * `COMBO` - Combo Chart * `PIE` - Pie Chart * `DONUT` - Donut Chart * `METRIC` - Metric * `TREND` - Trend * `WATERFALL` - Waterfall Chart
  - `settings` unknown
  - `data_sources` WidgetDataSource[]
    - `id` integer, required
    - `widget_id` string, uuid, required
    - `settings` unknown
    - `type` string, required
    - `object_id` string, required

---

[API](https://skmtc.net/cubesoftware/apis/cube-api.md) · [All operations](https://skmtc.net/cubesoftware/apis/cube-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cubesoftware/cube-api/revisions/67d9f45bb99b/schema)