getVIPs

suspend fun getVIPs(broadcasterId: String, userIds: List<String> = emptyList(), cursor: String? = null, pageSize: Int? = null): Page<ChannelRoleUser>

Twitch API: Get VIPs

Fetches a single page of VIPs for the broadcaster's channel.

Return

a Page containing the VIPs on this page and the cursor for the next page.

Parameters

broadcasterId

the ID of the broadcaster whose list of VIPs you want to get. This ID must match the user ID in the access token.

userIds

filters the list for specific VIPs. You may specify a maximum of 100 IDs.

cursor

the cursor used to get the next page of results. Pass null to get the first page.

pageSize

the maximum number of items to return (1–100). null uses the API default (20).