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

# /:channel

`GET /overlays/{channel}`

## Request

- Base URL: `https://api.streamelements.com/kappa/v2`
- URL: `https://api.streamelements.com/kappa/v2/overlays/{channel}`
- 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/get.ts> (a function with typed inputs; its response is checked against the schema)

List overlays

## Path parameters

- `channel` string, required

## Query parameters

- `search` string, required
- `type` string, required

## Response `200`

- OverlaysList
  - `total` integer, required
  - `docs` OverlayData[], required
    - `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
              - …
            - `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
              - …
            - `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
              - …
          - `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
              - …
            - `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
              - …
            - `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
              - …
            - `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
              - …
            - `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
              - …
          - `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

## Changes

- **2021-02-22** `51e3df32da57`: 14 breaking, 13 info
  - the response property `docs/items/widgets/variables/cheer/audio/src` became nullable for the status `200`
  - the response property `docs/items/widgets/variables/cheer/variations/items/settings/audio/src` became nullable for the status `200`
  - the response property `docs/items/widgets/variables/follower/audio/src` became nullable for the status `200`
  - the response property `docs/items/widgets/variables/host/audio/src` became nullable for the status `200`
  - …23 more
- **2021-02-08** `fb6ec574b6a7`: 1 info
  - added the optional property `docs/items/widgets` to the response with the `200` status
- **2021-02-07** `8c745ed2e9e4`: 11 warning
  - the optional response header `Access-Control-Allow-Credentials` removed for the status `200`
  - the optional response header `Access-Control-Expose-Headers` removed for the status `200`
  - the optional response header `ETag` removed for the status `200`
  - the optional response header `Server` removed for the status `200`
  - …7 more

[Operation history](https://skmtc.dev/streamelements/apis/se-api-docs/changes/overlays/:channel/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)