Get User Status
Returns the status of a user for one of your linked channels. The response will return either true or false.
Available status types:
- Check Subscriber
- Check Mod
- Check VIP
- Check Follower
This is an Async (Purple) Command, which operates differently from standard commands.
| Box Name | Type | Description |
|---|---|---|
| Channel | Dropdown | Twitch channel to get a user’s status for. This can be left empty. |
| User Name | String | User Name of the user to get the status for. |
| Type | Dropdown | Use the dropdown menu to choose the status type. |
| Save Variable As | String | Name of the variable to save the response as. |
Saved Value:
| Value | Type | Description |
|---|---|---|
| true | Boolean | The selected user has the requested status for the selected channel. |
| false | Boolean | The selected user does not have the requested status for the selected channel. |
| undefined | Undefined | Saved if Twitch is not connected, the channel/user cannot be resolved, required scopes are missing, or the request fails. |
Twitch API Endpoints:
| Status Type | Endpoint | Description |
|---|---|---|
| Check Subscriber | GET /helix/subscriptions/user |
Checks whether a specified user is subscribed to the broadcaster’s channel. |
| Check Mod | GET /helix/moderation/moderators |
Checks whether a specified user is a moderator in the broadcaster’s channel. |
| Check VIP | GET /helix/channels/vips |
Checks whether a specified user has VIP status in the broadcaster’s channel. |
| Check Follower | GET /helix/channels/followers |
Checks whether a specified user is following the broadcaster’s channel. |
| Query Parameter | Type | Description |
|---|---|---|
| broadcaster_id | string | The ID of the broadcaster’s channel to check against. |
| user_id | string | The ID of the user to check. |