Fields for a user object and the required oAuth2 Scope to view them.
Optional fields (Type ending with ?) or hidden fields (Missing oAuth2 Scope)
will have their value set as null instead.
Field
Type
Description
Required oAuth2 Scope
id
integer
their unique account id
identify
created
timestamp
their account creation timestamp
identify
public_flags
integer
their public flags (badges)
identify
username
string
their username
identify
displayname
string
their displayname
identify
subtitle
string
their pronouns, status, etc.
identify
biography
string
their biography
identify
accent_background
integer
their profile background color
identify
accent_banner
integer
their profile banner color
identify
accent_border
integer
their profile border color
identify
avatar
string?
their avatar image hash
identify
banner
string?
their banner image hash
identify
verified
boolean
has email been verified?
identify
email
string?
their email address
email
Usernames will always be alphanumeric with underscores and between 3-32 characters long
Usernames may change without warning, use account IDs instead!
Displaynames and Subtitles are up to 32 characters long
Biographies are up to 320 chracters long
Colors are in Decimal Representation
Use a Bitwise AND operation in your language of choice to see if a flag is
set for a user. Flags are primarily used for badges which are special achievements
that were obtainable for a limited time or gifted to specific users.
Value
Name
Description
Obtainable?
1 (1 << 0)
BADGE_CROWN
Reserved for bakonpancakz
Never
2 (1 << 1)
BADGE_VIP
Reserved for important users
No
4 (1 << 2)
BADGE_PICROSS
Awarded by completing Challenge #1
Yes
8 (1 << 3)
PUBLIC_UNAVAILABLE
Account is Unavailable
TOS Violation
Unavailable accounts, may be banned or deleted.
The reasoning will be sent to the account owners email.
GET /users/@me
Returns the current user if you have the identify scope, also
returns email if you also have the email scope.
Get Connections for Current User
GET /users/@me/connections
Requires the connections OAuth2 Scope.
Returns an array of Connection Objects the user is actively connected to.
Connection Object
Field
Type
Description
id
integer
Unique Connection ID
created
Date
ISO Timestamp of when connection was created
scopes
integer
Associated OAuth2 scopes with connection
application
Application Object
An Application Object
Quick link to Application Object.
GET /users/<user.username>
Returns a user object for a given username,
doesn't require any authorization.