Skip to content

Get-TwitterList

SYNOPSIS

Returns a specific list or all lists the authenticating or specified user owns.

SYNTAX

ByUser (Default)

Get-TwitterList [-User <User>] [-SearchName <String>] [-IncludeExpansions] [<CommonParameters>]

ByListId

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

DESCRIPTION

Returns a specific list or all lists the authenticating or specified user owns.

EXAMPLES

Example 1

PS > Get-TwitterList

Returns the lists the authenticating user owns.

Example 2

PS > Get-TwitterUser -User PowerShell_Team | Get-TwitterList

Returns the lists the specified user owns.

Example 3

PS > Get-TwitterList -Id 749356646665629696

Returns the specified list.

PARAMETERS

-User

A Twitter user object, returned by Get-TwitterUser, for which to retrieve the lists.

Type: BluebirdPS.APIV2.UserInfo.User
Parameter Sets: ByUser
Aliases:

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

-Id

The numerical id of the list.

Type: System.String
Parameter Sets: ByListId
Aliases:

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

-SearchName

Specifies the search string to match against the list Name property.

Note: All lists are returned, then filtered by the SearchName value. This capability is not inherently part of the Twitter API.

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

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

-IncludeExpansions

Include the list owner User object.

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

BluebirdPS.APIV1.List

BluebirdPS.APIV1.List[]

NOTES

Online Version

Api Reference - GET /2/lists/:id

Api Reference - GET /2/users/:id/owned_lists