Represents a user profile.
Main fields
These are always returned.
Unique (within the server) identifier for this user.
User’s first name.
User’s last name.
For restricted users, their restriction status. If this is set, none of the optional fields will be returned.
banned– The user’s account is frozen or suspended.deleted– The user has deleted their own profile.hidden– The server staff made this profile only visible to authenticated users.
Globally unique ActivityPub identifier for this user. Use this to match users across servers.
Optional fields
Unless otherwise noted, request these by passing them in fields to any method that returns user objects.
For a user from a remote server, the domain of their home server.
The profile URL a.k.a. the username. If the user doesn’t have one set, defaults to idXXX.
The status string, the one that’s displayed under the user’s name on the web.
The URL of this user’s profile page on the web. For remote users, this points to their home server.
User’s nickname of middle name.
User’s maiden name.
User’s preferred grammatical gender, to choose pronouns in strings that refer to them.
female– she/hermale– he/himother– they/them
User’s birth date as DD.MM.YYYY.
User’s hometown.
User’s relationship status.
actively_searching– Actively searchingcomplicated– It’s complicatedengaged– Engagedin_love– In lovein_relationship– In a relationshipmarried– Marriedsingle– Single
User’s relationship partner. Returned when relation field is requested.
Partner’s ID.
Partner’s first name.
Partner’s last name.
User-defined profile fields that some fediverse software like Mastodon allows specifying.
The field name specified by the user.
The field value as HTML.
User’s current city.
User’s Matrix username. Request by passing connections.
User’s XMPP/Jabber handle. Request by passing connections.
User’s Telegram username. Request by passing connections.
User’s Signal username or URL. Request by passing connections.
User’s Twitter username. Request by passing connections.
User’s Instagram username. Request by passing connections.
User’s Facebook username. Request by passing connections.
User’s VKontakte username. Request by passing connections.
User’s Snapchat username. Request by passing connections.
User’s Discord username. Request by passing connections.
User’s GitHub, GitLab, or other Git forge URL. Request by passing connections.
User’s Mastodon username. Request by passing connections.
User’s Pixelfed username. Request by passing connections.
User’s phone number. Request by passing connections.
User’s email address. Request by passing connections.
User’s personal website.
User’s activities.
User’s interests.
User’s favorite music.
User’s favorite movies.
User’s favorite TV shows.
User’s favorite books.
User’s favorite games.
User’s favorite quotes.
User’s about field as HTML.
User’s personal views.
Political views.
Possible values:
apathetic,
communist,
socialist,
moderate,
liberal,
conservative,
monarchist,
ultraconservative,
libertarian.
Religious views.
Sources of inspiration.
What this user considers important in others.
Possible values:
intellect_creativity,
kindness_honesty,
health_beauty,
wealth_power,
courage_persistence,
humor_life_love.
What this user considers personal priority.
Possible values:
family_children,
career_money,
entertainment_leisure,
science_research,
improving_world,
personal_development,
beauty_art,
fame_influence.
Views on smoking.
Possible values:
very_negative,
negative,
tolerant,
neutral,
positive.
Views on alcohol.
Possible values:
very_negative,
negative,
tolerant,
neutral,
positive.
Whether the user is currently online.
Whether the user is currently online from a mobile device. Request by passing online.
If the user is currently offline, information about when they were last online.
Last seen time as unixtime.
What kind of device the user last used to go online. TODO API online status
Possible values:
desktop,
mobile.
Whether the current user is blocked by this user.
Whether this user is blocked by the current user.
If true, you can send a friend request to this user. If false, you can only follow them.
Whether the current user can post on this user’s wall.
Whether the current user is allowed see all posts on this user’s wall, or only this user’s own posts.
Whether the current user is allowed send private messages to this user.
The number of mutual friends between this user and the current user.
Whether this user and the current user are friends.
The relationship between this user and the current user.
follow_requested– Only for remote users – current user tried to follow this user, but their server hasn’t yet accepted that requestfollowed_by– This user is following the current userfollowing– Current user is following this userfriends– Users are friends (they follow each other)none– No relationship
Whether this user is in the current user’s bookmarks. Requires the likes:read permission.
The current user’s friend list IDs that this user is in. Private lists are excluded unless the token has the friends:read permission.
Whether this user is hidden from the current user’s friends news feed.
Whether this user prefers their profile to not be indexed by search engines.
How this user’s wall should be displayed by default.
all– All postsowner– Only their own posts
URL of a square 50x50 version of the profile picture.
URL of a square 100x100 version of the profile picture.
URL of a square 200x200 version of the profile picture.
URL of a square 400x400 version of the profile picture.
URL of a rectangular 200px wide version of the profile picture.
URL of a rectangular 400px wide version of the profile picture.
If this user has a “profile pictures” system photo album, ID of the photo used for the current profile picture in that album.
First name inflections for Slavic languages. Values for case: nom – именительный, gen – родительный, dat – дательный, acc – винительный, ins – творительный, abl – предложный.
Last name inflections for Slavic languages. Values for case: nom – именительный, gen – родительный, dat – дательный, acc – винительный, ins – творительный, abl – предложный.
Middle name inflections for Slavic languages. Values for case: nom – именительный, gen – родительный, dat – дательный, acc – винительный, ins – творительный, abl – предложный.