Get VIPs
Gets a list of users that are VIPs in the specified broadcaster’s chat room.
This is an Async (Purple) Command, which operates differently from standard commands.
| Box Name | Type | Description |
|---|---|---|
| Channel | String | Channel name to get chatters of |
| Save Variable As | String | Variable to save the result |
Saved Payload:
| Variable Name | Type | Description |
|---|---|---|
| data | Array | Array of objects representing each VIP |
data[0-?] |
Object | contains info for a VIP |
data[0-?].user_id |
String | The user’s ID |
data[0-?].user_login |
String | The user’s login name |
data[0-?].user_name |
String | The user’s display name |
| pagination | Object | Contains the information used to page through the list of results. The object is empty if there are no more pages left to page through. |
| pagination.cursor | String | The cursor used to get the next page of results with Twitch API Call. |