Get Channel Point Rewards

Gets a list of the custom Channel Point Rewards for the specified channel. Will not return info on standard Rewards, like “Highlight This Message”. For more information on what the response contains, check out the Response Body table in the Twitch API Reference Guide for Get Custom Reward

Box Name Type Description
Channel String Channel name to get chatters of
Save Variable As String Variable to save the result

Saved Payload:

SAMMI saves the full response object returned by Twitch.

Variable Name Type Description
data Array Array of custom Channel Point Reward objects returned by Twitch.
data[0-?].id String Reward ID.
data[0-?].broadcaster_id String Twitch User ID of the broadcaster.
data[0-?].broadcaster_login String Login name of the broadcaster.
data[0-?].broadcaster_name String Display name of the broadcaster.
data[0-?].title String Reward title.
data[0-?].prompt String Reward description shown to viewers.
data[0-?].cost Number Channel Point cost.
data[0-?].background_color String Reward background color.
data[0-?].is_enabled Boolean Whether the reward is enabled.
data[0-?].is_user_input_required Boolean Whether viewer input is required.
data[0-?].is_paused Boolean Whether the reward is paused.
data[0-?].is_in_stock Boolean Whether the reward can currently be redeemed.
data[0-?].image Object Custom reward image URLs, if set.
data[0-?].default_image Object Default reward image URLs.
data[0-?].max_per_stream_setting Object Per-stream redemption limit settings.
data[0-?].max_per_user_per_stream_setting Object Per-user per-stream redemption limit settings.
data[0-?].global_cooldown_setting Object Global cooldown settings.
data[0-?].should_redemptions_skip_request_queue Boolean Whether redemptions skip the request queue.
data[0-?].redemptions_redeemed_current_stream Number Redemptions in the current stream, if available.
data[0-?].cooldown_expires_at String When the global cooldown expires, if active.
Back to the list