Skip to main content
Schemas.User

Properties

affiliation
Record<string, any>
Metadata about a user’s affiliation.
connectionStatus
("following" | "follow_request_received" | "follow_request_sent" | "blocking" | "followed_by" | "muting")[]
Returns detailed information about the relationship between two users.
createdAt
string
Creation time of this User.
description
string
The text of this User’s profile description (also known as bio), if the User provided one.
entities
Record<string, any>
A list of metadata found in the User’s profile description.
id
string
required
location
string
The location specified in the User’s profile, if the User provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries.
mostRecentTweetId
string
name
string
required
The friendly name of this User, as shown on their profile.
pinnedTweetId
string
profileBannerUrl
string
The URL to the profile banner for this User.
profileImageUrl
string
The URL to the profile image for this User.
protected
boolean
Indicates if this User has chosen to protect their Posts (in other words, if this User’s Posts are private).
publicMetrics
Record<string, any>
A list of metrics for this User.
receivesYourDm
boolean
Indicates if you can send a DM to this User
subscriptionType
"Basic" | "Premium" | "PremiumPlus" | "None"
The X Blue subscription type of the user, eg: Basic, Premium, PremiumPlus or None.
url
string
The URL specified in the User’s profile.
username
string
required
verified
boolean
Indicate if this User is a verified X User.
verifiedType
"blue" | "government" | "business" | "none"
The X Blue verified type of the user, eg: blue, government, business or none.
withheld
UserWithheld