---
title: "/:channel/:overlayId"
method: GET
path: "/overlays/{channel}/{overlayId}"
tags: ["overlays"]
---

# /:channel/:overlayId

`GET /overlays/{channel}/{overlayId}`

## Request

- Base URL: `https://api.streamelements.com/kappa/v2`
- URL: `https://api.streamelements.com/kappa/v2/overlays/{channel}/{overlayId}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://api.streamelements.com/oauth2/authorize`
    - Token URL: `https://api.streamelements.com/oauth2/token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/streamelements/apis/se-api-docs/docs/overlays/:channel/:overlayId/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets overlay details with all widgets on it

## Path parameters

- `channel` string, required
- `overlayId` string, required

## Response `200`

- OverlayData
  - `settings` OverlaySettings, required
    - `width` integer, required
    - `height` integer, required
    - `name` string, required
  - `widgets` Widget
    - `id` integer, required
    - `type` string, required
    - `visible` boolean, required
    - `locked` boolean, required
    - `listeners` Listeners, required
      - `tip-latest` boolean, required
      - `subscriber-latest` boolean, required
      - `follower-latest` boolean, required
      - `cheer-latest` boolean, required
      - `host-latest` boolean, required
      - `raid-latest` boolean, required
      - `redemption-latest` boolean
    - `css` Css, required
      - `z-index` integer, required
      - `top` string, required
      - `left` string, required
      - `width` string, required
      - `height` string, required
      - `opacity` integer, required
    - `text` Text, required
      - `type` string, required
      - `enableShadow` boolean, required
      - `scrolling` Scrolling, required
        - `direction` string, required
        - `speed` integer, required
      - `css` Css1, required
        - `position` string, required
        - `z-index` integer, required
        - `font-family` string, required
        - `font-size` integer, required
        - `color` string, required
        - `font-weight` string, required
        - `text-shadow` string, required
        - `text-align` string, required
        - `line-height` number, required
        - `message` Message, required
          - `enableShadow` boolean, required
          - `font-family` string, required
          - `font-size` integer, required
          - `line-height` number, required
          - `color` string, required
          - `text-align` string, required
    - `image` Image, required
      - `type` string, required
      - `css` Css2, required
        - `max-width` string, required
    - `video` Video, required
      - `type` string, required
      - `css` Css3, required
        - `widget` integer, required
        - `height` integer, required
    - `audio` Audio, required
      - `type` string, required
      - `volume` integer, required
    - `animation` Animation, required
      - `in` string, required
      - `out` string, required
      - `timeout` integer
      - `hide` boolean
    - `variables` Variables, required
      - `css` string
      - `html` string
      - `js` string
      - `follower` Follower
        - `enableRandomPick` boolean, required
        - `enabled` boolean, required
        - `duration` integer, required
        - `layout` string, required
        - `text` Text1, required
          - `animation` string, required
          - `css` TextCSS, required
            - `font-family` string, required
            - `font-size` integer, required
            - `color` string, required
            - `font-weight` string, required
            - `text-shadow` string, required
            - `text-align` string, required
            - `highlights` Highlights, required
              - …
            - `message` Message1, required
              - …
          - `enableShadow` boolean, required
          - `message` string, required
        - `graphics` Graphics, required
          - `src` string, nullable, required
          - `type` string, required
        - `audio` Audio1, required
          - `src` string, nullable, required
          - `volume` number
        - `animation` Animation, required
          - `in` string, required
          - `out` string, required
          - `timeout` integer
          - `hide` boolean
        - `variations` string[], required
      - `subscriber` Subscriber1
        - `enableRandomPick` boolean, required
        - `enabled` boolean, required
        - `duration` integer, required
        - `layout` string, required
        - `text` Text1, required
          - `animation` string, required
          - `css` TextCSS, required
            - `font-family` string, required
            - `font-size` integer, required
            - `color` string, required
            - `font-weight` string, required
            - `text-shadow` string, required
            - `text-align` string, required
            - `highlights` Highlights, required
              - …
            - `message` Message1, required
              - …
          - `enableShadow` boolean, required
          - `message` string, required
        - `graphics` Graphics, required
          - `src` string, nullable, required
          - `type` string, required
        - `audio` Audio1, required
          - `src` string, nullable, required
          - `volume` number
        - `animation` Animation, required
          - `in` string, required
          - `out` string, required
          - `timeout` integer
          - `hide` boolean
        - `variations` Variation[], required
          - `name` string, required
          - `type` string, required
          - `condition` string
          - `requirement` integer
          - `settings` SubVariationSettings, required
            - `layout` string, required
            - `text` Text3, required
              - …
            - `graphics` Graphics, required
              - …
        - `tts` Tts, required
          - `enabled` boolean, required
          - `voice` string, required
          - `volume` number, required
          - `minAmount` integer, required
      - `tip` Tip1
        - `enableRandomPick` boolean, required
        - `enabled` boolean, required
        - `duration` integer, required
        - `layout` string, required
        - `text` Text1, required
          - `animation` string, required
          - `css` TextCSS, required
            - `font-family` string, required
            - `font-size` integer, required
            - `color` string, required
            - `font-weight` string, required
            - `text-shadow` string, required
            - `text-align` string, required
            - `highlights` Highlights, required
              - …
            - `message` Message1, required
              - …
          - `enableShadow` boolean, required
          - `message` string, required
        - `graphics` Graphics, required
          - `src` string, nullable, required
          - `type` string, required
        - `audio` Audio1, required
          - `src` string, nullable, required
          - `volume` number
        - `animation` Animation, required
          - `in` string, required
          - `out` string, required
          - `timeout` integer
          - `hide` boolean
        - `variations` string[], required
        - `tts` Tts, required
          - `enabled` boolean, required
          - `voice` string, required
          - `volume` number, required
          - `minAmount` integer, required
      - `host` Host1
        - `enableRandomPick` boolean, required
        - `enabled` boolean, required
        - `duration` integer, required
        - `layout` string, required
        - `text` Text1, required
          - `animation` string, required
          - `css` TextCSS, required
            - `font-family` string, required
            - `font-size` integer, required
            - `color` string, required
            - `font-weight` string, required
            - `text-shadow` string, required
            - `text-align` string, required
            - `highlights` Highlights, required
              - …
            - `message` Message1, required
              - …
          - `enableShadow` boolean, required
          - `message` string, required
        - `graphics` Graphics, required
          - `src` string, nullable, required
          - `type` string, required
        - `audio` Audio1, required
          - `src` string, nullable, required
          - `volume` number
        - `animation` Animation, required
          - `in` string, required
          - `out` string, required
          - `timeout` integer
          - `hide` boolean
        - `variations` string[], required
        - `minAmount` integer, required
      - `raid` Raid1
        - `enableRandomPick` boolean, required
        - `enabled` boolean, required
        - `duration` integer, required
        - `layout` string, required
        - `text` Text1, required
          - `animation` string, required
          - `css` TextCSS, required
            - `font-family` string, required
            - `font-size` integer, required
            - `color` string, required
            - `font-weight` string, required
            - `text-shadow` string, required
            - `text-align` string, required
            - `highlights` Highlights, required
              - …
            - `message` Message1, required
              - …
          - `enableShadow` boolean, required
          - `message` string, required
        - `graphics` Graphics, required
          - `src` string, nullable, required
          - `type` string, required
        - `audio` Audio1, required
          - `src` string, nullable, required
          - `volume` number
        - `animation` Animation, required
          - `in` string, required
          - `out` string, required
          - `timeout` integer
          - `hide` boolean
        - `variations` string[], required
      - `cheer` Cheer1
        - `enableRandomPick` boolean, required
        - `enabled` boolean, required
        - `duration` integer, required
        - `layout` string, required
        - `text` Text1, required
          - `animation` string, required
          - `css` TextCSS, required
            - `font-family` string, required
            - `font-size` integer, required
            - `color` string, required
            - `font-weight` string, required
            - `text-shadow` string, required
            - `text-align` string, required
            - `highlights` Highlights, required
              - …
            - `message` Message1, required
              - …
          - `enableShadow` boolean, required
          - `message` string, required
        - `graphics` Graphics, required
          - `src` string, nullable, required
          - `type` string, required
        - `audio` Audio1, required
          - `src` string, nullable, required
          - `volume` number
        - `animation` Animation, required
          - `in` string, required
          - `out` string, required
          - `timeout` integer
          - `hide` boolean
        - `variations` Variation1[], required
          - `name` string, required
          - `condition` string, required
          - `requirement` integer, required
          - `layout` string
          - `settings` CheerAlertSettings, required
            - `graphics` Graphics, required
              - …
            - `audio` Audio1, required
              - …
            - `text` Text1, required
              - …
        - `tts` Tts, required
          - `enabled` boolean, required
          - `voice` string, required
          - `volume` number, required
          - `minAmount` integer, required
    - `provider` string, required
    - `staffOnly` boolean, required
    - `version` number
  - `type` string, required
  - `preview` string, required
  - `mobile` boolean, required
  - `_id` string, required
  - `game` string, nullable, required
  - `name` string, required
  - `channel` string, required
  - `createdAt` string, required
  - `updatedAt` string, required

## Other responses

- `400`: Bad Request
- `404`: Not Found

## Changes

- **2021-02-22** `51e3df32da57`: 14 breaking, 13 info
  - the response property `widgets/variables/cheer/audio/src` became nullable for the status `200`
  - the response property `widgets/variables/cheer/variations/items/settings/audio/src` became nullable for the status `200`
  - the response property `widgets/variables/follower/audio/src` became nullable for the status `200`
  - the response property `widgets/variables/host/audio/src` became nullable for the status `200`
  - …23 more
- **2021-02-08** `fb6ec574b6a7`: 2 breaking, 15 info
  - the response property `widgets` became optional for the status `200`
  - the `widgets` response's property type changed from `array` to `object` for status `200`
  - added the optional property `widgets/version` to the response with the `200` status
  - added the required property `widgets/animation` to the response with the `200` status
  - …13 more
- **2021-02-08** `8421cd25897f`: 7 breaking
  - the response property `widgets/items/variables/cheer/graphics/src` became nullable for the status `200`
  - the response property `widgets/items/variables/cheer/variations/items/settings/graphics/src` became nullable for the status `200`
  - the response property `widgets/items/variables/follower/graphics/src` became nullable for the status `200`
  - the response property `widgets/items/variables/host/graphics/src` became nullable for the status `200`
  - …3 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/streamelements/apis/se-api-docs/changes/overlays/:channel/:overlayId/get.md)

---

[API](https://skmtc.dev/streamelements/apis/se-api-docs.md) - [All operations](https://skmtc.dev/streamelements/apis/se-api-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/streamelements/apis/se-api-docs/revisions/aa13169b9373?raw)