Skip to content

Get-TwitterListSubscriber

SYNOPSIS

Returns the subscribers of the specified list.

SYNTAX

ShowId

Get-TwitterListSubscriber -ListId <String> [-ResultsPerPage <Int32>] [-SkipStatus] [-ExcludeEntities] [<CommonParameters>]

ShowSlugOwnerId

Get-TwitterListSubscriber -Slug <String> -OwnerId <Int64> [-ResultsPerPage <Int32>] [-SkipStatus] [-ExcludeEntities] [<CommonParameters>]

ShowSlugOwnerScreenName

Get-TwitterListSubscriber -Slug <String> -OwnerScreenName <String> [-ResultsPerPage <Int32>] [-SkipStatus] [-ExcludeEntities] [<CommonParameters>]

DESCRIPTION

Returns the subscribers of the specified list.

Private list subscribers will only be shown if the authenticated user owns the specified list.

EXAMPLES

Example 1

PS > Get-TwitterListSubscriber -ListId 857199747848957957

Returns the users that subscribe to the list specified.

Example 2

PS > Get-TwitterListSubscriber -Slug microsoft-evangelicals -OwnerScreenName thedavecarroll

Returns the users that are subscribe to the list specified.

PARAMETERS

-ListId

The numerical id of the list.

Type: String
Parameter Sets: ShowId
Aliases:

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

-Slug

Returns the specified list based on the slug which is derived from the name of the list.

Note: Provide the list owner when returning a list based on the slug.

Type: String
Parameter Sets: ShowSlugOwnerId, ShowSlugOwnerScreenName
Aliases:

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

-OwnerId

The ID of the list owner for whom to return results.

Type: Int64
Parameter Sets: ShowSlugOwnerId
Aliases:

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

-OwnerScreenName

The screen name of the user for whom to return results.

Type: String
Parameter Sets: ShowSlugOwnerScreenName
Aliases:

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

-ExcludeEntities

Exclude the entities node.

This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ResultsPerPage

Specifies the number of results to retrieve per page.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-SkipStatus

Exclude the user statuses from the returned user objects.

Type: 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.Object

NOTES

Online Version

Get-TwitterListSubscription

Get-TwitterList

Get-TwitterListMember

Get-TwitterListByOwner

Get-TwitterListTweets

Api Reference - GET lists/subscribers