list

suspend fun list(broadcasterId: String, ids: List<String> = emptyList(), onlyManageableRewards: Boolean = false): List<CustomReward>

Twitch API: Get Custom Reward

Gets a list of custom rewards that the specified broadcaster created. A channel may offer a maximum of 50 rewards, which includes both enabled and disabled rewards.

Return

the list of custom rewards, in ascending order by id.

Parameters

broadcasterId

the ID of the broadcaster whose custom rewards you want to get. This ID must match the user ID found in the OAuth token.

ids

a list of IDs to filter the rewards by. You may specify a maximum of 50 IDs.

onlyManageableRewards

a Boolean value that determines whether the response contains only the custom rewards that the app may manage (the app is identified by the ID in the Client-Id header). Set to true to get only the custom rewards that the app may manage. The default is false.