Skip to main content
GET
Get muted chat users
Returns the users muted in the authenticated broadcaster’s chat. Mutes are scoped to the broadcaster, not to an individual broadcast, and apply across every broadcast that user hosts. This endpoint lists only the authenticated user’s own mutes. A chat moderator can’t use it to list the mutes of a broadcaster they moderate for. Timed mutes include their expiry time. Expired timed mutes are omitted from the response. Pass expansions=user_id to include the muted users’ user objects in the response.

Pagination

The response includes meta.next_token whenever a page is full, even if no more results remain. As a result, the last page of results can be followed by an empty page. To fetch the next page, pass the next_token value as pagination_token. Keep paging until the response has no next_token or returns an empty page.
To mute or unmute a user, use Mute a Chat User or Unmute a Chat User.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

max_results
integer<int32>
Required range: 1 <= x <= 100
pagination_token
string
Minimum string length: 1
broadcast_chat_mute.fields
enum<string>[]

A comma separated list of BroadcastChatMute fields to display. The fields available for a BroadcastChatMute object.

Minimum array length: 1
Available options:
end_at_ms
expansions
enum<string>[]

A comma separated list of fields to expand.

Minimum array length: 1
Available options:
user_id
user.fields
enum<string>[]

A comma separated list of User fields to display. The fields available for a User object.

Minimum array length: 1
Available options:
active_follower_count,
confirmed_email,
connection_status,
created_at,
description,
entities,
id,
is_identity_verified,
location,
name,
parody,
profile_banner_url,
profile_image_url,
protected,
public_metrics,
receives_your_dm,
subscriber_count,
subscribes_to_you,
subscription,
subscription_type,
url,
username,
verified,
verified_followers_count,
verified_type,
withheld

Response

The request has succeeded.

data
object[]
errors
object[]
includes
object
meta
object