User Avatar v3

The user's resolved v3 avatar: every enabled catalog option with the value their level entitles them to, and the custom avatar once they have one and are at least the unlock level. Use GET /v3/avatars/catalog to know what each value means.

get/v3/users/{route_users_id}/avatar

Request

  • Base URL
    https://api.sidequestvr.com
  • URL
    https://api.sidequestvr.com/v3/users/{route_users_id}/avatar
  • Auth
    none declared

Path parameters

route_users_idstring required

The users_id, or "me"

Response

Success

users_idinteger required

The users_id this avatar belongs to

levelinteger required

The user's current level, derived from their XP. Options above this level fall back to their defaults.

optionsobject required

Map of option_key to the selected value, e.g. {"base":"robot"}. Every enabled catalog option with a default is present; options with no default are present only when chosen.

Changes