Get-TwitterList
SYNOPSIS
Returns a specific list or all lists the authenticating or specified user subscribes to, including their own.
SYNTAX
ListScreenName (Default)
Get-TwitterList [-ScreenName <String>] [-OwnedListFirst] [<CommonParameters>]
ListUserId
Get-TwitterList -UserId <String> [-OwnedListFirst] [<CommonParameters>]
ShowId
Get-TwitterList -ListId <String> [<CommonParameters>]
ShowSlugOwnerId
Get-TwitterList -Slug <String> -OwnerId <Int64> [<CommonParameters>]
ShowSlugOwnerScreenName
Get-TwitterList -Slug <String> -OwnerScreenName <String> [<CommonParameters>]
DESCRIPTION
Returns a specific list or all lists the authenticating or specified user subscribes to, including their own.
EXAMPLES
Example 1
PS > Get-TwitterList
Returns the lists owned by the authenticating user.
Example 2
PS > Get-TwitterList -UserId 123456789
Returns the lists owned by the specified user.
Example 3
PS > Get-TwitterList -ListId 749356646665629696
Returns the specified list.
Example 4
PS > Get-TwitterList -Slug powershell-team -OwnerScreenName powershell_team
Returns the specified list owned by the specified owner.
PARAMETERS
-ScreenName
The screen name of the user for whom to return results.
Type: String
Parameter Sets: ListScreenName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UserId
The ID of the user for whom to return results.
Type: String
Parameter Sets: ListUserId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OwnedListFirst
Return the authenticating user's lists first.
Type: SwitchParameter
Parameter Sets: ListScreenName, ListUserId
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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 user id that owns the list specified by the Slug parameter.
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 that owns the list specified by the Slug parameter.
Type: String
Parameter Sets: ShowSlugOwnerScreenName
Aliases:
Required: True
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.