Skip to main content

APIUser

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

Index

Properties

Properties

accent_color

accent_color: null | number

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

avatar

avatar: string

The user’s avatar hash

@see

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

optionalavatar_decoration

avatar_decoration?: string

The user’s avatar decoration hash

@see

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

banner

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

optionalflags

flags?: UserFlags

The flags on a user’s account

@see

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

optionalglobal_name

global_name?: 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

@see

https://discord.com/developers/docs/reference#locales

optionalmfa_enabled

mfa_enabled?: boolean

Whether the user has two factor enabled on their account

premium_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