Skip to main content

User

Structure

FieldTypeDescriptionOptionalDeprecated
_idstringThe user's username.
lower_usernamestringThe lower-case version of the user's username.
uuidUUID4 or nullThe user's UUID4.
createdinteger or nullThe user's creation timestamp in Unix seconds.
pfp_datainteger or nullThe user's selected profile picture.
avatarstringThe ID of the avatar the user has. If the user has not set an avatar, this is an empty string.
avatar_colorstringThe border color of the avatar. A six-digit hex color.
quotestring or nullThe user's quote.
flagsintegerThe user's flags.
permissionsinteger or nullThe user's admin permissions. See below for details.
lvlintegerThe user's admin level.
ban*User Ban objectBan status associated with the user.
bannedbooleanWhether the user is currently banned.
last_seeninteger or nullThe timestamp in Unix seconds of when the user was last online.
delete_after*integer or nullThe timestamp in Unix seconds of when the user is scheduled to be deleted.

* These fields are only returned when a user is fetching their own user profile.

Permissions

Permissions are implemented as bit maps. This means that they're stored as numbers, that should then be converted to binary. The indices where there is a binary 1 show that the permission at that index is given. In many languages, this can be consisely written as (permissions & (1 << permission)) != 0.

IndexNumberPermission
01Sysadmin; can do anything
12Can view reports
24Can handle reports
38Can view notes on posts and users
416Can edit notes on posts or users
532Can view posts in any chat
664Can delete posts in any chat
7128Can view which alts a user has
8256Can send alerts
9512Can kick users
101024Can clear a user's profile details
112048Can view ban states
124096Can ban or unban users
138192Can delete users
1416384Can view the IP adress of users
1532768Can block certain IP adresses
1665536Can view chat information
17131072Can edit chat information
18262144Can send announcements
19524288Can change which words are blocked by the profanity filter

Examples

Own user profile

{
"_id": "MikeDEV",
"lower_username": "mikedev",
"uuid": "a887becf-fe1d-492a-92c3-e2af7d15db28",
"created": 1649983115,
"pfp_data": 26,
"quote": "🦆👋 Friendly neighborhood duck enthusiast. Owner of Meower!",
"flags": 0,
"permissions": 1,
"lvl": 0,
"ban": {
"state": "none",
"restrictions": 0,
"expires": 0,
"reason": ""
},
"banned": false,
"last_seen": 1706574821,
"delete_after": null
}

Other user profile

{
"_id": "MikeDEV",
"lower_username": "mikedev",
"uuid": "a887becf-fe1d-492a-92c3-e2af7d15db28",
"created": 1649983115,
"pfp_data": 26,
"quote": "🦆👋 Friendly neighborhood duck enthusiast. Owner of Meower!",
"flags": 0,
"permissions": 1,
"lvl": 0,
"banned": false,
"last_seen": 1706574821
}