---
title: "Get widget metadata"
method: GET
path: "/widget_metadata_url_path_placeholder"
tags: ["Widgets"]
---

# Get widget metadata

`GET /widget_metadata_url_path_placeholder`

## Request

- Base URL: `{siteUrl}`
- URL: `{siteUrl}/widget_metadata_url_path_placeholder`
- Auth: none declared

_Note: The path is a placeholder. The actual path is determined by the configuration of the app component._

Get the metadata from the app server to render a widget. <br> <br> <a href="https://d3ki9tyy5l5ruj.cloudfront.net/obj/92841480867031372af8983f2906d26fbff6a2cc/ac-widget-metadata.png">
  <img src="https://d3ki9tyy5l5ruj.cloudfront.net/obj/92841480867031372af8983f2906d26fbff6a2cc/ac-widget-metadata.png" alt="App components widget metadata request flow"/>
</a>

## Response `200`

Successfully retrieved the metadata for a single widget.

- WidgetMetadataResponse: An object containing information about the widget.
  - `template` 'summary_with_details_v0', required: The interface name and version of a distinct widget UI layout. A `template` is directly associated with a particular `metadata` schema.
  - `metadata` object, required: The metadata (i.e., underlying definition) of a widget. `metadata` must exist alongside a `template`, and its schema must be specific to the value of that `template`.
    - `title` string, required: The text to show in the title of the widget. Max length of 200 characters.
    - `fields` unknown[], required: A list of fields showing data from external resources (i.e., an array of WidgetField objects). A widget must contain at least 1 field and no more than 5 fields. Valid object schemas: [WidgetField-DatetimeWithIcon](/reference/widgets#widgetfield-datetimewithicon), [WidgetField-Pill](/reference/widgets#widgetfield-pill), [WidgetField-TextWithIcon](/reference/widgets#widgetfield-textwithicon).
      - unknown
    - `subtitle` string: The text to show under the title of the widget, next to "Open in {App Name}". If not provided, the `resource_name` from the app definition will be used as default.
    - `subicon_url` string: The URL of the subicon next to the subtitle . If not provided, no icon will be shown.
    - `footer` object, required: Contains the information to display a footer on the widget. Valid schemas: [WidgetFooter-Created](/reference/widgets#widgetfooter-created), [WidgetFooter-CustomText](/reference/widgets#widgetfooter-customtext), [WidgetFooter-Updated](/reference/widgets#widgetfooter-updated).
    - `num_comments` integer: The number of comments to display on the lower right corner of the widget. If not provided, no comment count will be shown

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `418`: Unauthorized
- `500`: Server error

---

[API](https://skmtc.dev/asana/apis/app-components.md) - [All operations](https://skmtc.dev/asana/apis/app-components/llms.txt) - [OpenAPI document](https://skmtc.dev/asana/apis/app-components/revisions/bbebcce5c9f6?raw)