store

/:channel/items

Changed on Feb 22, 2021

List store items

get/store/{channel}/items

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/store/:channel/items/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

limitinteger required

Example:25

integer - number of items per page

offsetinteger required

integer - number of items to be skipped

Headers

Acceptstring required

Example:application/json; charset=utf-8

Response

subscriberOnlyboolean required

userInputstring[] required

_idstring required

enabledboolean required

featuredboolean required

namestring required

descriptionstring required

typestring required

costinteger required

publicboolean required

channelstring required

createdAtstring required

updatedAtstring required

Example response

[
  {
    "bot": {
      "enabled": true,
      "identifier": "testitem"
    },
    "cooldown": {
      "user": 5,
      "global": 0
    },
    "quantity": {
      "total": -1
    },
    "alert": {
      "graphics": {
        "duration": 8
      },
      "audio": {
        "volume": 0.5,
        "src": null
      },
      "enabled": true
    },
    "subscriberOnly": false,
    "userInput": [],
    "_id": "5c0bb2aede9a4c4402a15056",
    "enabled": true,
    "featured": false,
    "name": "Test item",
    "description": "Test description",
    "type": "perk",
    "cost": 1,
    "public": false,
    "channel": "5b2e2007760aeb7729487dab",
    "createdAt": "2018-12-08T12:01:50.208Z",
    "updatedAt": "2018-12-08T12:02:47.902Z"
  },
  {
    "bot": {
      "enabled": true,
      "identifier": "super_item"
    },
    "cooldown": {
      "user": 10,
      "global": 0
    },
    "quantity": {
      "total": 3,
      "current": 3
    },
    "alert": {
      "graphics": {
        "duration": 8
      },
      "audio": {
        "volume": 0.5,
        "src": "https://cdn.streamelements.com/uploads/08e58dd8-b750-4113-a496-2b5817fd8031.mp3"
      },
      "enabled": true
    },
    "subscriberOnly": false,
    "userInput": [],
    "_id": "5c0bb3b0de9a4c40a3a1505d",
    "enabled": true,
    "featured": false,
    "name": "Super item",
    "description": "Super description",
    "type": "code",
    "cost": 100,
    "preview": "https://cdn.streamelements.com/uploads/dbf6ff1f-3d03-4db7-a4bd-43d30e22461a.gif",
    "public": false,
    "channel": "5b2e2007760aeb7729487dab",
    "createdAt": "2018-12-08T12:06:08.435Z",
    "updatedAt": "2018-12-08T12:06:08.435Z"
  }
]

Changes

Feb 22, 202151e3df32da57 Revision changes
- breaking
  the response property /// became optional for the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property // from the response with the status
- info
  added the optional property / to the response with the status
Feb 7, 20218c745ed2e9e4 Revision changes
- warning
  the optional response header Access-Control-Allow-Credentials removed for the status 200
- warning
  the optional response header Access-Control-Expose-Headers removed for the status 200
- warning
  the optional response header ETag removed for the status 200
- warning
  the optional response header Server removed for the status 200
- warning
  the optional response header Strict-Transport-Security removed for the status 200
- warning
  the optional response header X-Content-Type-Options removed for the status 200
- warning
  the optional response header X-DNS-Prefetch-Control removed for the status 200
- warning
  the optional response header X-Download-Options removed for the status 200
- warning
  the optional response header X-Frame-Options removed for the status 200
- warning
  the optional response header X-Requested-From removed for the status 200
- warning
  the optional response header X-XSS-Protection removed for the status 200
- warning
  deleted the header request parameter Content-Type

Operation history