Preview environment

interface APIUserWithMember

extends

APIUser
export interface APIUserWithMember extends APIUser

optional
accent_color? : number | null

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

Inherited from: APIUser

optional
avatar_decoration_data? : APIAvatarDecorationData | null

The data for the user's avatar decoration

Inherited from: APIUser

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

deprecatedoptional
avatar_decoration? : string | null

The user's avatar decoration hash

Inherited from: APIUser

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

avatar : string | null

The user's avatar hash

Inherited from: APIUser

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

The user's banner hash

Inherited from: APIUser

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

optional
bot? : boolean

Whether the user belongs to an OAuth2 application

Inherited from: APIUser

optional
collectibles? : APICollectibles | null

The data for the user's collectibles

Inherited from: APIUser

See also: https://discord.com/developers/docs/resources/user#collectiblesundefined

discriminator : string

The user's Discord-tag

Inherited from: APIUser

optional
email? : string | null

The user's email

Inherited from: APIUser

optional
flags? : UserFlags

The flags on a user's account

Inherited from: APIUser

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

global_name : string | null

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

Inherited from: APIUser

id : Snowflake

The user's id

Inherited from: APIUser

optional
locale? : string

The user's chosen language option

Inherited from: APIUser

optional
member? : APIGuildMemberNoUser

The member field is only present in MESSAGE_CREATE and MESSAGE_UPDATE events from text-based guild channels

See also: https://discord.com/developers/docs/resources/guild#guild-member-objectundefined

optional
mfa_enabled? : boolean

Whether the user has two factor enabled on their account

Inherited from: APIUser

optional
premium_type? : UserPremiumType

The type of Nitro subscription on a user's account

Inherited from: APIUser

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

optional
primary_guild? : APIUserPrimaryGuild | null

The user's primary guild

Inherited from: APIUser

See also: https://discord.com/developers/docs/resources/user#user-object-user-primary-guildundefined

optional
public_flags? : UserFlags

The public flags on a user's account

Inherited from: APIUser

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

optional
system? : boolean

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

Inherited from: APIUser

username : string

The user's username, not unique across the platform

Inherited from: APIUser

optional
verified? : boolean

Whether the email on this account has been verified

Inherited from: APIUser