Sign in

v1

latestOpenAPI 3.0.22026-07-1715222.2 KB
Admin Extension State

Get Extension-wide Viewer State

If the request includes a query parameter list of Twitch user IDs and the requesting JWT auth token is admin-level, returns a mapping of those user IDs to their extension-side viewer state, removing any that are not found.

If no list of IDs is provided and the JWT auth token is viewer-level, returns a JSON object of the viewer's extension-wide state. This is associated with the current viewer, but across all channels.

get/extension_viewer_state

Query parameters

{"stackTrail":"paths:/extension_viewer_state:get:parameters:0:schema:items","oasType":"schema","type":"unknown"}

Response

One or more viewer state objects depending on request.

object required

Any JSON serializable data

OR
object required

A mapping of user IDs to viewer extension state

Example response

{
  "hello": "world"
}