Skip to content

/v1/getProfile

GET the profile of a user

Parameters

Query Parameters

ParameterDescriptionRequired
accountIdThe account ID of the userYes
usernameThe username of the userYes

Only required either accountId or username present, not both.

Response

A profile object with the following properties:

NameTypeDescription
accountIdnumberThe account ID of the user.
usernamestringThe username of the user.
sparksnumberThe sparks of the user.
planetsnumberThe planets of the user.
blueCoinsnumberThe blue coins of the user.
creatorPointsnumberThe creator points of the user.
isBoosternumberWhether the user is a booster.
isSupporternumberWhether the user is a supporter.
modRolenumberThe mod role of the user. (0=user, 1=mod, 2=admin)
json
{
  "accountId": 7689052,
  "username": "ArcticWoof",
  "sparks": 1142,
  "planets": 87,
  "blueCoins": 35,
  "creatorPoints": 1,
  "isBooster": false,
  "isSupporter": false,
  "modRole": 2
}

Failed Response

Missing accountId or username
User not found