Skip to content

Authorized User

GET /me/profile

Get authorized user profile

Authentication

Type Required
Bearer Yes

Example Response

{
  "user_id": 0,
  "username": "Example",
  "member_since": 1776959901,
  "networth": 0,
  "display_name": null,
  "status": null,
  "bio": null,
  "avatar": {
    "head_color": "#C8C8C8",
    "torso_color": "#23590A",
    "left_arm_color": "#C8C8C8",
    "right_arm_color": "#C8C8C8",
    "left_leg_color": "#8E5226",
    "right_leg_color": "#8E5226"
  },
  "accent_color": null,
  "banner_url": "",
  "equipped_items": [],
  "badges": [],
  "friend_count": 0,
  "place_count": 0,
  "item_count": 0,
  "last_active": 1776959901,
  "allow_joins": true,
  "is_owner": false
}

PUT /me/profile

Update user's profile

Authentication

Type Required
Bearer Yes

Example Request

Headers
Header Required Value
Content-Type Yes application/json
Body
{
  "bio": "Example"
}

Info

Currently known available parameters to edit are display_name, bio, status, allow_joins, and accent_color.

All parameters in the avatar table are available to edit, however they must be outside of the avatar table.

Note

If a parameter is not provided in the request body, it will be set to null or a predefined default value.

Example Response

{
  "user_id": 0,
  "username": "Example",
  "member_since": 1776959901,
  "networth": 0,
  "display_name": null,
  "status": null,
  "bio": "Example",
  "avatar": {
    "head_color": "#C8C8C8",
    "torso_color": "#23590A",
    "left_arm_color": "#C8C8C8",
    "right_arm_color": "#C8C8C8",
    "left_leg_color": "#8E5226",
    "right_leg_color": "#8E5226"
  },
  "accent_color": null,
  "banner_url": "",
  "equipped_items": [],
  "badges": [],
  "friend_count": 0,
  "place_count": 0,
  "item_count": 0,
  "last_active": 1776959901,
  "allow_joins": true,
  "is_owner": false
}

GET /me/friends

Get authorized user friends

Authentication

Type Required
Bearer Yes

Example Response

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}

GET /me/inventory

Get authorized user inventory

Note

This appears to be identical to GET /me/friends.

Authentication

Type Required
Bearer Yes

Example Response

{
    "items": [],
    "total": 0,
    "limit": 50,
    "offset": 0
}

GET /me/items

Get authorized user items

Note

This appears to be identical to GET /me/inventory.

Authentication

Type Required
Bearer Yes

Example Response

{
    "items": [],
    "total": 0,
    "limit": 50,
    "offset": 0
}