APIUser

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

Index

Properties

• accent_color
• avatar
• avatar_decoration
• avatar_decoration_data
• banner
• bot
• discriminator
• email
• flags
• global_name
• id
• locale
• mfa_enabled
• premium_type
• public_flags
• system
• username
• verified

Properties

optionalaccent_color

accent_color?: null | number

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

avatar

avatar: null | string

The user's avatar hash

See https://discord.com/developers/docs/reference#image-formatting

optionalavatar_decoration

avatar_decoration?: null | string

The user's avatar decoration hash

See https://discord.com/developers/docs/reference#image-formatting

@deprecated

Use avatar_decoration_data instead

optionalavatar_decoration_data

avatar_decoration_data?: null | APIAvatarDecorationData

The data for the user's avatar decoration

See https://discord.com/developers/docs/resources/user#avatar-decoration-data-object

optionalbanner

banner?: null | string

The user's banner hash

See https://discord.com/developers/docs/reference#image-formatting

optionalbot

bot?: boolean

Whether the user belongs to an OAuth2 application

discriminator

discriminator: string

The user's Discord-tag

optionalemail

email?: null | string

The user's email

optionalflags

flags?: UserFlags

The flags on a user's account

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

global_name

global_name: null | string

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

id

id: string

The user's id

optionallocale

locale?: string

The user's chosen language option

optionalmfa_enabled

mfa_enabled?: boolean

Whether the user has two factor enabled on their account

optionalpremium_type

premium_type?: UserPremiumType

The type of Nitro subscription on a user's account

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

optionalpublic_flags

public_flags?: UserFlags

The public flags on a user's account

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

optionalsystem

system?: boolean

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

username

username: string

The user's username, not unique across the platform

optionalverified

verified?: boolean

Whether the email on this account has been verified