---
title: "GET /v2/widgets/{widgetId}"
method: GET
path: "/v2/widgets/{widgetId}"
tags: ["widgets"]
---

# GET /v2/widgets/{widgetId}

`GET /v2/widgets/{widgetId}`

## Path parameters

- `widgetId` string, required

## Query parameters

- `text` string
- `categoryIds` string[]
- `preferCategoryIds` string[]
- `excludeCategoryIds` string[]

## Headers

- `x-app-referrer` string, required

## Response `200`

Widget By Id

- Widget
  - `type` 'inline' | 'expanding' | 'mobile-expanding' | 'docked' | 'carousel' | 'sidebar' | 'playlist', required
  - `id` string, required
  - `name` string, required
  - `creatorId` string, required
  - `creator` Creator, required
    - `avatar` string, required
    - `id` string, required
    - `partnerName` string, required
    - `avatarAssetId` string, required
    - `profileColor` string, required
    - `userName` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `playlistId` string, required
  - `playlist` Playlist, required
    - `language` 'en-us' | 'es-mx', required
    - `gameSet` GameSet
      - `id` string, required
      - `partnerId` string
      - `partner` Creator, required
        - `avatar` string, required
        - `id` string, required
        - `partnerName` string, required
        - `avatarAssetId` string, required
        - `profileColor` string, required
        - `userName` string, required
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `startTime` string, date-time, required
      - `endTime` string, date-time, required
      - `deletedAt` string, date-time, required
      - `games` Game[], required
        - `audioUrl` string, required
        - `videoUrls` VideoUrls, required
          - `hls` string, required
          - `mp4360` string, required
          - `mp4540` string, required
          - `mp4720` string, required
          - `poster` string, required
        - `questionVideoUrls` VideoUrls, required
          - `hls` string, required
          - `mp4360` string, required
          - `mp4540` string, required
          - `mp4720` string, required
          - `poster` string, required
        - `landscapeVideoUrls` VideoUrls, required
          - `hls` string, required
          - `mp4360` string, required
          - `mp4540` string, required
          - `mp4720` string, required
          - `poster` string, required
        - `resultUrls` VideoUrls, required
          - `hls` string, required
          - `mp4360` string, required
          - `mp4540` string, required
          - `mp4720` string, required
          - `poster` string, required
        - `state` 'new' | 'active' | 'waiting_for_declaration' | 'declaring_winner' | 'winner_declared' | 'changing_game_result' | 'processing_payouts' | 'ended' | 'canceled' | 'refunded' | 'quarantined', required
        - `language` 'en-us' | 'es-mx', required
        - `gameType` 'POLL' | 'PREDICTION' | 'INSTANT_POLL' | 'TRIVIA' | 'SURVEY' | 'THIS_THAT', required
        - `orientation` 'landscape' | 'portrait'
        - `correctAnswer` 'A' | 'B'
        - `id` string, required
        - `creatorId` string, required
        - `creator` Creator, required
          - `avatar` string, required
          - `id` string, required
          - `partnerName` string, required
          - `avatarAssetId` string, required
          - `profileColor` string, required
          - `userName` string, required
          - `createdAt` string, date-time, required
          - `updatedAt` string, date-time, required
        - `startTime` string, date-time, required
        - `endTime` string, date-time, required
        - `lastJoinTime` string, date-time, required
        - `gameTitle` string, required
        - `sourceUrl` string, required
        - `sideA` string, required
        - `sideB` string, required
        - `videoAssetId` string
        - `questionVideoAssetId` string
        - `landscapeVideoAssetId` string
        - `audioAssetId` string
        - `resultAssetId` string
        - `text` string, required
        - `categoryId` string, required
        - `category` Category, required
          - `language` 'en-us' | 'es-mx', required
          - `id` string, required
          - `categoryName` string, required
          - `createdAt` string, required
          - `updatedAt` string, required
          - `deletedAt` string, required
          - `sticker` string
          - `icon` string
        - `isAd` boolean, required
        - `isPrivate` boolean
        - `bingSearch` string
        - `bingSearchClaim` string
        - `metadata` object
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
        - `version` number, required
        - `urls` string[]
    - `id` string, required
    - `totalGames` number, required
    - `creatorId` string, required
    - `creator` Creator, required
      - `avatar` string, required
      - `id` string, required
      - `partnerName` string, required
      - `avatarAssetId` string, required
      - `profileColor` string, required
      - `userName` string, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
    - `widgets` Widget[], required
    - `gamesOrder` string[]
    - `games` Game[], required
      - `audioUrl` string, required
      - `videoUrls` VideoUrls, required
        - `hls` string, required
        - `mp4360` string, required
        - `mp4540` string, required
        - `mp4720` string, required
        - `poster` string, required
      - `questionVideoUrls` VideoUrls, required
        - `hls` string, required
        - `mp4360` string, required
        - `mp4540` string, required
        - `mp4720` string, required
        - `poster` string, required
      - `landscapeVideoUrls` VideoUrls, required
        - `hls` string, required
        - `mp4360` string, required
        - `mp4540` string, required
        - `mp4720` string, required
        - `poster` string, required
      - `resultUrls` VideoUrls, required
        - `hls` string, required
        - `mp4360` string, required
        - `mp4540` string, required
        - `mp4720` string, required
        - `poster` string, required
      - `state` 'new' | 'active' | 'waiting_for_declaration' | 'declaring_winner' | 'winner_declared' | 'changing_game_result' | 'processing_payouts' | 'ended' | 'canceled' | 'refunded' | 'quarantined', required
      - `language` 'en-us' | 'es-mx', required
      - `gameType` 'POLL' | 'PREDICTION' | 'INSTANT_POLL' | 'TRIVIA' | 'SURVEY' | 'THIS_THAT', required
      - `orientation` 'landscape' | 'portrait'
      - `correctAnswer` 'A' | 'B'
      - `id` string, required
      - `creatorId` string, required
      - `creator` Creator, required
        - `avatar` string, required
        - `id` string, required
        - `partnerName` string, required
        - `avatarAssetId` string, required
        - `profileColor` string, required
        - `userName` string, required
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
      - `startTime` string, date-time, required
      - `endTime` string, date-time, required
      - `lastJoinTime` string, date-time, required
      - `gameTitle` string, required
      - `sourceUrl` string, required
      - `sideA` string, required
      - `sideB` string, required
      - `videoAssetId` string
      - `questionVideoAssetId` string
      - `landscapeVideoAssetId` string
      - `audioAssetId` string
      - `resultAssetId` string
      - `text` string, required
      - `categoryId` string, required
      - `category` Category, required
        - `language` 'en-us' | 'es-mx', required
        - `id` string, required
        - `categoryName` string, required
        - `createdAt` string, required
        - `updatedAt` string, required
        - `deletedAt` string, required
        - `sticker` string
        - `icon` string
      - `isAd` boolean, required
      - `isPrivate` boolean
      - `bingSearch` string
      - `bingSearchClaim` string
      - `metadata` object
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `version` number, required
      - `urls` string[]
    - `autofilledGames` Game[], required
      - `audioUrl` string, required
      - `videoUrls` VideoUrls, required
        - `hls` string, required
        - `mp4360` string, required
        - `mp4540` string, required
        - `mp4720` string, required
        - `poster` string, required
      - `questionVideoUrls` VideoUrls, required
        - `hls` string, required
        - `mp4360` string, required
        - `mp4540` string, required
        - `mp4720` string, required
        - `poster` string, required
      - `landscapeVideoUrls` VideoUrls, required
        - `hls` string, required
        - `mp4360` string, required
        - `mp4540` string, required
        - `mp4720` string, required
        - `poster` string, required
      - `resultUrls` VideoUrls, required
        - `hls` string, required
        - `mp4360` string, required
        - `mp4540` string, required
        - `mp4720` string, required
        - `poster` string, required
      - `state` 'new' | 'active' | 'waiting_for_declaration' | 'declaring_winner' | 'winner_declared' | 'changing_game_result' | 'processing_payouts' | 'ended' | 'canceled' | 'refunded' | 'quarantined', required
      - `language` 'en-us' | 'es-mx', required
      - `gameType` 'POLL' | 'PREDICTION' | 'INSTANT_POLL' | 'TRIVIA' | 'SURVEY' | 'THIS_THAT', required
      - `orientation` 'landscape' | 'portrait'
      - `correctAnswer` 'A' | 'B'
      - `id` string, required
      - `creatorId` string, required
      - `creator` Creator, required
        - `avatar` string, required
        - `id` string, required
        - `partnerName` string, required
        - `avatarAssetId` string, required
        - `profileColor` string, required
        - `userName` string, required
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
      - `startTime` string, date-time, required
      - `endTime` string, date-time, required
      - `lastJoinTime` string, date-time, required
      - `gameTitle` string, required
      - `sourceUrl` string, required
      - `sideA` string, required
      - `sideB` string, required
      - `videoAssetId` string
      - `questionVideoAssetId` string
      - `landscapeVideoAssetId` string
      - `audioAssetId` string
      - `resultAssetId` string
      - `text` string, required
      - `categoryId` string, required
      - `category` Category, required
        - `language` 'en-us' | 'es-mx', required
        - `id` string, required
        - `categoryName` string, required
        - `createdAt` string, required
        - `updatedAt` string, required
        - `deletedAt` string, required
        - `sticker` string
        - `icon` string
      - `isAd` boolean, required
      - `isPrivate` boolean
      - `bingSearch` string
      - `bingSearchClaim` string
      - `metadata` object
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `version` number, required
      - `urls` string[]
    - `autofillCategories` Category[]
      - `language` 'en-us' | 'es-mx', required
      - `id` string, required
      - `categoryName` string, required
      - `createdAt` string, required
      - `updatedAt` string, required
      - `deletedAt` string, required
      - `sticker` string
      - `icon` string
    - `autofillCreators` Creator[]
      - `avatar` string, required
      - `id` string, required
      - `partnerName` string, required
      - `avatarAssetId` string, required
      - `profileColor` string, required
      - `userName` string, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
    - `autofillExcludedCreators` Creator[]
      - `avatar` string, required
      - `id` string, required
      - `partnerName` string, required
      - `avatarAssetId` string, required
      - `profileColor` string, required
      - `userName` string, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
    - `autofill` boolean, required
  - `deletedAt` string, date-time, required

---

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