Skip to main content
Module

x/discord_api_types/payloads/v8/user.ts>APIUser

Up to date Discord API Typings, versioned by the API version
discordjs/discord-api-types
Go to Latest
interface APIUser
Deprecated
Deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

import { type APIUser } from "https://deno.land/x/discord_api_types@0.37.11/payloads/v8/user.ts";

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

Properties

id: Snowflake

The user's id

username: string

The user's username, not unique across the platform

discriminator: string

The user's 4-digit discord-tag

avatar: string | null

The user's avatar hash

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

optional
bot: boolean

Whether the user belongs to an OAuth2 application

optional
system: boolean

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

optional
mfa_enabled: boolean

Whether the user has two factor enabled on their account

optional
banner: string | null

The user's banner hash

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

optional
accent_color: number | null

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

optional
locale: string

The user's chosen language option

optional
verified: boolean

Whether the email on this account has been verified

optional
email: string | null

The user's email

optional
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

optional
public_flags: UserFlags

The public flags on a user's account

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