Skip to content

Get-TwitterMutedUser

SYNOPSIS

Returns a collection of user objects or array of user ids that the authenticating user has muted.

SYNTAX

Get-TwitterMutedUser [-IncludeExpansions] [-MaxResultsPerPage <Int32>] [-NoPagination] [<CommonParameters>]

DESCRIPTION

Returns a collection of user objects or array of user ids that the authenticating user has muted.

EXAMPLES

Example 1

PS > Get-TwitterMutedUser

Returns a list of user ids the authenticating user has muted.

Example 2

PS > Get-TwitterMutedUser | Get-TwitterUser

Use the list of user ids the authenticating user has muted as input for Get-TwitterUser.

PARAMETERS

-IncludeExpansions

Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MaxResultsPerPage

The maximum number of results to be return by each page of the request.

Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.

You can force the command only return a single page with the NoPagination switch.

Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoPagination

Only return the first page of data for the request.

Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.String[]

NOTES

Online Version

Set-TwitterMutedUser

Get-TwitterUser

API Documentation - GET /2/users/:id/muting