getRedemptions

suspend fun getRedemptions(broadcasterId: String, rewardId: String, status: RedemptionStatus? = null, ids: List<String> = emptyList(), sort: RedemptionSort? = null, cursor: String? = null, pageSize: Int? = null): Page<RewardRedemption>

Twitch API: Get Custom Reward Redemption

Gets a single page of redemptions for the specified reward.

Return

a Page of RewardRedemption objects.

Parameters

broadcasterId

the ID of the broadcaster that owns the custom reward. This ID must match the user ID found in the OAuth token.

rewardId

the ID that identifies the custom reward whose redemptions you want to get.

status

filters the list by redemption status. Possible values: CANCELED, FULFILLED, UNFULFILLED.

ids

a list of IDs to filter the redemptions by (max 50).

sort

the order to sort redemptions by. Possible values: OLDEST, NEWEST. Default: OLDEST.

cursor

the cursor used to get the next page of results.

pageSize

the maximum number of redemptions to return per page (1-50, default 20). Null uses the API default.