Skip to main content

​
User Resource

The User resource represents a Fluxer user account with profile information, authentication details, and premium status.

​
User Object

​
Structure

​
id
Snowflake
required
Unique user identifier
​
username
string
required
The user’s unique username (2-32 characters)
​
discriminator
integer
required
The user’s discriminator number (0-9999). Premium users can have 0.
​
global_name
string | null
The user’s display name (1-32 characters)
​
bot
boolean
default:"false"
Whether this user is a bot
​
system
boolean
default:"false"
Whether this is a system user (Fluxer official)
​
email
string | null
The user’s email address (private, only visible to the user)
​
email_verified
boolean
default:"false"
Whether the email has been verified
​
phone
string | null
The user’s phone number (private)
​
avatar_hash
string | null
Hash of the user’s avatar image
​
avatar_color
integer | null
Fallback color for the avatar (RGB integer)
​
banner_hash
string | null
Hash of the user’s profile banner
​
banner_color
integer | null
Fallback color for the banner (RGB integer)
​
accent_color
integer | null
User’s theme accent color (RGB integer)
​
bio
string | null
User’s profile bio (max 190 characters)
​
pronouns
string | null
User’s pronouns (max 40 characters)
​
locale
string | null
User’s preferred locale (e.g., “en-US”)
​
flags
string
Bitfield of user flags (see User Flags)
​
public_flags
integer
Publicly visible subset of flags
​
premium_type
integer | null
Premium subscription type (see Premium Types)
​
premium_since
ISO8601 timestamp | null
When the user’s premium subscription started

​
Example User

{
  "id": "123456789012345678",
  "username": "fluxeruser",
  "discriminator": 1234,
  "global_name": "Fluxer User",
  "bot": false,
  "system": false,
  "avatar_hash": "a1b2c3d4e5f6",
  "avatar_color": 5793266,
  "banner_hash": null,
  "banner_color": 3447003,
  "accent_color": 3447003,
  "bio": "Building the future of communication",
  "pronouns": "they/them",
  "locale": "en-US",
  "flags": "0",
  "public_flags": 0,
  "premium_type": 1,
  "premium_since": "2024-01-15T10:30:00.000Z"
}

​
User Flags

User flags are a bitfield representing various user states and badges.

​
Premium Types

​
Authenticator Types

​
Endpoints

​
Get Current User

GET /api/v1/users/@me
Returns the authenticated user’s profile including private fields.

​
Get User

GET /api/v1/users/{user_id}
Returns a public user profile.

​
Modify Current User

PATCH /api/v1/users/@me
Update the authenticated user’s profile.
​
username
string
New username (2-32 characters)
​
global_name
string | null
New display name (1-32 characters, null to remove)
​
avatar
string | null
Base64 encoded image data or null to remove
​
banner
string | null
Base64 encoded image data or null to remove
​
bio
string | null
New bio (max 190 characters)
​
pronouns
string | null
New pronouns (max 40 characters)
​
accent_color
integer | null
New accent color (RGB integer)

​
Delete User

DELETE /api/v1/users/@me
Deletes the authenticated user’s account. This action is irreversible after the grace period.
​
password
string
required
User’s current password for verification

Build docs developers (and LLMs) love

Get started for freeTalk to us