@typed-discord/rest
    Preparing search index...

    Interface UserPIIResponse

    interface UserPIIResponse {
        accent_color?: number | null;
        avatar: string | null;
        avatar_decoration_data?: UserAvatarDecorationResponse | null;
        banner?: string | null;
        bot?: boolean;
        collectibles?: UserCollectiblesResponse | null;
        discriminator: string;
        email?: string | null;
        flags: number;
        global_name: string | null;
        id: `${bigint}`;
        locale: AvailableLocalesEnum;
        mfa_enabled: boolean;
        premium_type?: PremiumTypes;
        primary_guild?: UserPrimaryGuildResponse | null;
        public_flags: number;
        system?: boolean;
        username: string;
        verified?: boolean;
    }
    Index

    Properties

    accent_color? avatar 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

    accent_color?: number | null

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

    avatar: string | null

    the user's avatar hash

    avatar_decoration_data?: UserAvatarDecorationResponse | null

    data for the user's avatar decoration

    banner?: string | null

    the user's banner hash

    bot?: boolean

    whether the user belongs to an OAuth2 application

    collectibles?: UserCollectiblesResponse | null

    data for the user's collectibles

    discriminator: string

    the user's Discord-tag

    email?: string | null
    flags: number

    the flags on a user's account

    global_name: string | null

    the user's display name, if it is set

    id: `${bigint}`

    the user's id

    locale: AvailableLocalesEnum
    mfa_enabled: boolean
    premium_type?: PremiumTypes
    primary_guild?: UserPrimaryGuildResponse | null
    public_flags: number

    the public flags on a user's account

    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

    verified?: boolean

    Settings

    Member Visibility

    On This Page

    Properties