Interface APIUser

See

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

interface APIUser {
    accent_color?: null | number;
    avatar: null | string;
    avatar_decoration?: null | string;
    avatar_decoration_data?: null | APIAvatarDecorationData;
    banner?: null | string;
    bot?: boolean;
    collectibles?: null | APICollectibles;
    discriminator: string;
    email?: null | string;
    flags?: UserFlags;
    global_name: null | string;
    id: string;
    locale?: string;
    mfa_enabled?: boolean;
    premium_type?: UserPremiumType;
    primary_guild?: null | APIUserPrimaryGuild;
    public_flags?: UserFlags;
    system?: boolean;
    username: string;
    verified?: boolean;
}

Hierarchy (View Summary)

Properties

accent_color? avatar avatar_decoration? avatar_decoration_data? banner? bot? collectibles? discriminator email? flags? global_name id locale? mfa_enabled? premium_type? primary_guild? 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 APIUser.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

Optionalcollectibles

collectibles?: null | APICollectibles

The data for the user's collectibles

See

https://discord.com/developers/docs/resources/user#collectibles

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

Optionalprimary_guild

primary_guild?: null | APIUserPrimaryGuild

The user's primary guild

See

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

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

Settings

Member Visibility

On This Page

Properties