Preview environment

interface APIUser

export interface APIUser

https://discord.com/developers/docs/resources/user#user-object

optional
accent_color? : number | null

The user's banner color encoded as an integer representation of hexadecimal color code

optional
avatar_decoration_data? : APIAvatarDecorationData | null

The data for the user's avatar decorationSee https://discord.com/developers/docs/resources/user#avatar-decoration-data-object

deprecatedoptional
avatar_decoration? : string | null

The user's avatar decoration hashSee https://discord.com/developers/docs/reference#image-formatting

avatar : string | null

The user's avatar hashSee https://discord.com/developers/docs/reference#image-formatting

The user's banner hashSee https://discord.com/developers/docs/reference#image-formatting

optional
bot? : boolean

Whether the user belongs to an OAuth2 application

discriminator : string

The user's Discord-tag

optional
email? : string | null

The user's email

optional
flags? : UserFlags

The flags on a user's accountSee https://discord.com/developers/docs/resources/user#user-object-user-flags

global_name : string | null

The user's display name, if it is set. For bots, this is the application name

id : Snowflake

The user's id

optional
locale? : string

The user's chosen language option

optional
mfa_enabled? : boolean

Whether the user has two factor enabled on their account

optional
premium_type? : UserPremiumType

The type of Nitro subscription on a user's accountSee https://discord.com/developers/docs/resources/user#user-object-premium-types

optional
public_flags? : UserFlags

The public flags on a user's accountSee https://discord.com/developers/docs/resources/user#user-object-user-flags

optional
system? : boolean

Whether the user is an Official Discord System user (part of the urgent message system)

username : string

The user's username, not unique across the platform

optional
verified? : boolean

Whether the email on this account has been verified