List signed-in viewers
Every account that has signed in to the tip page (Twitch or Kick), most recently signed-in first, each with the person’s sub-reward credit balance (summed across their linked accounts, so a viewer who signed in here with both shows two rows with the same balance). Viewers who have never signed in don’t appear - signing in is what creates a viewer. Requires viewers:read.
/viewersAuthorizationBearer token (tp_live_... or tpat_...) · headerrequiredA TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.
limitintegerbeforestringCursor - the next_cursor from a previous page. Opaque (base64url of the sign-in time + platform + id the page ended on); a malformed one answers 400 bad_cursor. Returns viewers who signed in before that point.
One page of viewers, newest sign-up first.
viewersobject[]Show propertiesHide properties
objectplatformstringrequiredtwitchkickplatform_user_idstringrequiredloginstring | nulldisplay_namestring | nullprofile_image_urlstring<uri> | nullsubscriber_tierintegerTheir sub tier as last seen (0 = not subscribed).
0123first_signed_in_atstring<date-time>When they first signed in to this tip page.
last_active_atstring<date-time>Last account activity seen (profile refreshes included).
linked_accountsobject[]requiredThe person's OTHER platform accounts - never the one above. Empty when nothing is linked.
Show propertiesHide properties
objectplatformstringtwitchkickplatform_user_idstringloginstring | nulldisplay_namestring | nullcreditsCreditBalanceA viewer's sub-reward credit balance.
Show propertiesHide properties
availableintegerCredits spendable right now.
totalintegerCredits ever granted.
usedintegerCredits already spent.
has_morebooleannext_cursorstring | nullPass as before to fetch the next page.
Unknown before cursor (bad_cursor).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
The key lacks the required scope (missing_scope).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
required_scopestringRate limit exceeded - check the RateLimit-* headers.
errorstring