GlobalUser

View User Profile By Username

Changed on

Resolves a username (compared case-insensitively) and returns that users public profile. A platform-banned account's is only users_id and profile_hidden, except to an admin or the account itself.

get/v2/users/by-username/{username}

Request

  • Base URL
    https://api.sidequestvr.com
  • URL
    https://api.sidequestvr.com/v2/users/by-username/{username}
  • Auth
    none declared

Path parameters

usernamestring required

The users unique username

Response

Success

usernameobject

The users unique username, if they have set one

users_idinteger required

The users unique ID

nameobject required

The users display name

preview_imagestring required

The users avatar preview image

score_pointsobject required

The users total score points

profile_type'Gamer' | 'Developer' | 'Streamer' | 'Influencer' required

The users profile type

  • Gamer - Normal SideQuest user
  • Developer - An app developer
  • Streamer - A streamer or content creator
  • Influencer - A public influencer
tag_lineobject required

The users tag line

createdobject required

The time this user was created

bioobject required

The users bio

profile_hiddenboolean

True when the account was deleted or is banned from the platform. Anyone but an admin or the account itself then gets only users_id and this.

Changes