Skip to content

Get-TwitterList

SYNOPSIS

Returns a specific list or all lists the authenticating or specified user subscribes to, including their own.

SYNTAX

ByListUserName (Default)

Get-TwitterList [-UserName <String>] [-OwnedListFirst] [<CommonParameters>]

ById

Get-TwitterList -Id <String> [<CommonParameters>]

BySlug

Get-TwitterList -Slug <String> [-OwnerUserName <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 the authenticating user subscribes to, including their own.

Example 2

PS > Get-TwitterList -UserName BluebirdPS

Returns the lists that the user BluebirdPS subscribes to, including their own.

Example 3

PS > Get-TwitterList -Id 749356646665629696

Returns the specified list.

Example 4

PS > Get-TwitterList -Slug powershell-team -OwnerUserName powershell_team

Returns the specified list owned by the specified owner.

PARAMETERS

-UserName

Returns the lists that the specified user subscribes to, including their own.

If UserName, Id, and Slug are not provided, this command will return the lists for the authenticating user.

Type: String
Parameter Sets: ByListUserName
Aliases:

Required: False
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: ByListUserName
Aliases:

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

-Id

The numerical id of the list.

Type: String
Parameter Sets: ById
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: BySlug
Aliases:

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

-OwnerUserName

The username of the user that owns the list specified by the Slug parameter.

Type: String
Parameter Sets: BySlug
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

BluebirdPS.APIV1.List

BluebirdPS.APIV1.List[]

NOTES

Online Version

Get-TwitterListByOwner

Api Reference - GET lists/list

Api Reference - GET lists/show