Skip to content

Get-TwitterUser

SYNOPSIS

Returns a variety of information about the specified user.

SYNTAX

__AllParameterSets

Get-TwitterUser [[-User <String[]>]] [-IncludeExpansions] [<CommonParameters>]

DESCRIPTION

Returns a variety of information about the specified user.

If no input is provided, returns the authenticating user.

EXAMPLES

Example 1

PS > Get-TwitterUser
Id              : 292670084
Name            : Dave Carroll
UserName        : thedavecarroll
CreatedAt       : 5/4/2011 1:22:46 AM
Description     : Married to an amazing woman. #PowerShell #Blogger #RushTheBand #RetroComputing #Puns #Doggos #Tech #StarTrek #INTJ https://t.co/fLbRHoxt39
Entities        : {https://powershell.anovelidea.org/, https://pronoun.is/he}
Location        : Nashville, TN
PinnedTweetId   : 1385709814890864648
ProfileImageUrl : https://pbs.twimg.com/profile_images/1332944757186760704/s4AjaIMg_normal.jpg
Protected       : False
PublicMetrics   : FollowersCount: 947, FollowingCount: 1654, ListedCount: 27, TweetCount: 6475
Url             : https://t.co/G5ojwP677I
Verified        : False
Withheld        :

Return the authenticating user's information.

Example 2

PS > Get-TwitterUser -User 1330877955057344513,thedavecarroll,TwitterDev

Return the user information for the 3 specified users.

Example 3

PS > 3234616374,1330877955057344513,'thedavecarroll' |  Get-TwitterUser

Return the user information for the specified user.

PARAMETERS

-User

One or more identifiers for a Twitter user. You can provide UserName, Id, or a combination of both as this command will send the appropriate request to the Twitter API.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True (None) False (All)
Position: 0
Default value:
Accept pipeline input: True
Accept wildcard characters: False

-IncludeExpansions

Include the pinned Tweet for the returned user(s).

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

System.String

OUTPUTS

BluebirdPS.APIV2.UserInfo.User

BluebirdPS.APIV2.UserInfo.User[]

NOTES

Online Version

Api Reference - GET /2/users/by

Api Reference - GET /2/users/by/username/:username

Api Reference - GET /2/users

Api Reference - GET /2/users/:id