Files
VRChatBackendDocs/Models/User.md
ExilProductions aa707d1deb add subdir
2026-02-15 17:39:26 +01:00

4.9 KiB

User

Properties

Name Type Description Notes
ageVerificationStatus String `verified` is obsolete. User who have verified and are 18+ can switch to `plus18` status. [default to null]
ageVerified Boolean `true` if, user is age verified (not 18+). [default to null]
allowAvatarCopying Boolean [default to true]
badges List [optional] [default to null]
bio String [default to null]
bioLinks List [default to null]
currentAvatarImageUrl String When profilePicOverride is not empty, use it instead. [default to null]
currentAvatarTags List [default to null]
currentAvatarThumbnailImageUrl String When profilePicOverride is not empty, use it instead. [default to null]
date_joined date [default to null]
developerType String "none" User is a normal user "trusted" Unknown "internal" Is a VRChat Developer "moderator" Is a VRChat Moderator Staff can hide their developerType at will. [default to none]
displayName String A users visual display name. This is what shows up in-game, and can different from their `username`. Changing display name is restricted to a cooldown period. [default to null]
friendKey String [default to null]
friendRequestStatus String [optional] [default to null]
id String A users unique ID, usually in the form of `usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469`. Legacy players can have old IDs in the form of `8JoV9XEdpo`. The ID can never be changed. [default to null]
instanceId String InstanceID can be "offline" on User profiles if you are not friends with that user and "private" if you are friends and user is in private instance. [optional] [default to null]
isFriend Boolean Either their `friendKey`, or empty string if you are not friends. Unknown usage. [default to null]
last_activity String Either a date-time or empty string. [default to null]
last_login String Either a date-time or empty string. [default to null]
last_mobile String [optional] [default to null]
last_platform String This is normally `android`, `ios`, `standalonewindows`, `web`, or the empty value ``, but also supposedly can be any random Unity version such as `2019.2.4-801-Release` or `2019.2.2-772-Release` or even `unknownplatform`. [default to null]
location String Represents a unique location, consisting of a world identifier and an instance identifier, or "offline" if the user is not on your friends list. [optional] [default to null]
note String [optional] [default to null]
platform String [optional] [default to null]
profilePicOverride String [default to null]
profilePicOverrideThumbnail String [default to null]
pronouns String [default to null]
state String * "online" User is online in VRChat * "active" User is online, but not in VRChat * "offline" User is offline Always offline when returned through `getCurrentUser` (/auth/user). [default to offline]
status String Defines the User's current status, for example "ask me", "join me" or "offline. This status is a combined indicator of their online activity and privacy preference. [default to offline]
statusDescription String [default to null]
tags List [default to null]
travelingToInstance String [optional] [default to null]
travelingToLocation String [optional] [default to null]
travelingToWorld String [optional] [default to null]
userIcon String [default to null]
username String - A users unique name, used during login. This is different from `displayName` which is what shows up in-game. A users `username` can never be changed.' DEPRECATED: VRChat API no longer return usernames of other users. See issue by Tupper for more information.
worldId String WorldID be "offline" on User profiles if you are not friends with that user. [optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]