overlays

/:channel

Changed on Feb 22, 2021

List overlays

get/overlays/{channel}

Request

Base URL
https://api.streamelements.com/kappa/v2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://api.streamelements.com/oauth2/authorize
  Token URLhttps://api.streamelements.com/oauth2/token
- or 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.

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

Query parameters

searchstring required

typestring required

Example:tip

Response

totalinteger required

Example response

{
  "total": 1,
  "docs": [
    {
      "settings": {
        "width": 1920,
        "height": 1080,
        "name": "1080p"
      },
      "type": "regular",
      "preview": "https://static-cdn.jtvnw.net/ttv-static/404_boxart-272x380.jpg",
      "mobile": false,
      "_id": "5b2e2041760aeb87a0487dc7",
      "game": null,
      "name": "snake",
      "channel": "5b2e2007760aeb7729487dab",
      "createdAt": "2018-06-23T10:26:09.04Z",
      "updatedAt": "2018-06-23T10:34:21.168Z"
    }
  ]
}

Changes

Feb 22, 202151e3df32da57 Revision changes
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ///////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property ////// became nullable for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property ////// became optional for the status
- breaking
  the response property ////// became optional for the status
- breaking
  the response property ////// became optional for the status
- breaking
  the response property ////// became optional for the status
- breaking
  the response property ////// became optional for the status
- breaking
  the response property ////// became optional for the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ///////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
Feb 8, 2021fb6ec574b6a7 Revision changes
- info
  added the optional property // to the response with the status

Operation history (3 revisions)

/:channel

Request

Path parameters

Query parameters

Response 200OK

Example response

Changes

Response