Discord Objects

class discord.objects.Application

approximate_guild_count: Optional[int]

Approximate count of guilds the app has been added to

approximate_user_authorization_count: Optional[int]

Approximate count of users that have OAuth2 authorization for the app

approximate_user_install_count: Optional[int]

Approximate count of users that have installed the app (authorized with application.commands as a scope)

bot: Optional[User]

Partial user object for the bot user associated with the app

bot_public: bool

When False, only the app owner can add the app to the guilds

bot_require_code_grant: bool

When True, the app’s bot will only join upon completion of the full OAuth2 code grant flow

cover_image: Optional[str]

App’s default rich presence invite cover image hash

custom_install_url: Optional[str]

Default custom authorization URL for the app, if enabled

description: str

Description of the app

event_webhook_status: Optional[ApplicationEventWebhookStatus]

If webhook events are enabled for the app. 1 (default) means disabled, 2 means enabled, 3 means disabled by Discord

event_webhooks_types: Optional[list[WebhookEventType]]

List of WebhookEventTypes the app subscribes to

event_webhooks_url: Optional[Nullable[str]]

Event webhooks URL for the app to receive webhook events

flags: Optional[ApplicationFlag]

App’s public flags

guild: Optional[Guild]

Partial object of the associated guild

guild_id: Optional[Snowflake]

Guild associated with the app. For example, a developer support server.

icon: Nullable[str]

Icon hash of the app

id: Snowflake

ID of the app

install_params: Optional[InstallParams]

Settings for the app’s default in-app authorization link, if enabled

integration_types_config: Optional[dict[ApplicationIntegrationType, ApplicationIntegrationTypeConfiguration]]

Default scopes and permissions for each supported installation context

interactions_endpoint_url: Optional[Nullable[str]]

Interactions endpoint URL for the app

name: str

Name of the app

owner: Optional[User]

Partial user object for the owner of the app

primary_sku_id: Optional[Snowflake]

If this app is a game sold on Discord, this field will be the id of the “Game SKU” that is created, if exists

privacy_policy_url: Optional[str]

URL of the app’s Privacy Policy

redirect_uris: Optional[list[str]]

Array of redirect URIs for the app

role_connections_verification_url: Optional[Nullable[str]]

Role connections verification URL for the app

rpc_origins: Optional[list[str]]

List of RPC origin URLs, if RPC is enabled

slug: Optional[str]

If this app is a game sold on Discord, this field will be the URL slug that links to the store page

tags: Optional[list[str]]

List of tags describing the content and functionality of the app. Max of 5 tags.

team: Nullable[Team]

If the app belongs to a team, this will be a list of the members of that team

terms_of_service_url: Optional[str]

URL of the app’s Terms of Service

verify_key: str

Hex encoded key for verification in interactions and the Game SDK’s GetTicket

class discord.objects.ApplicationCommandPermissions

Application command permissions allow you to enable or disable commands for specific users, roles, or channels within a guild.

id: Snowflake

ID of the role, user, or channel. It can also be a permission constant

permission: bool

True to allow, False to disallow

type: ApplicationCommandPermissionType

Role, user, or channel

class discord.objects.ApplicationIntegrationTypeConfiguration

oauth2_install_params: Optional[InstallParams]

Install params for each installation context’s default in-app authorization link

class discord.objects.AutoModerationAction

An action which will execute whenever a rule is triggered.

* metadata can be omitted based on type.

metadata: Optional[AutoModerationActionMetadata]

Additional metadata needed during execution for this specific action type

type: AutoModerationActionType

The type of action

class discord.objects.AutoModerationActionMetadata

Additional data used when an action is executed. Different fields are relevant based on the value of action type.

channel_id: Snowflake

Channel to which user content should be logged.

Associated action type: SEND_ALERT_MESSAGE

Constraints: Existing channel

custom_message: Optional[str]

Additional explanation that will be shown to members whenever their message is blocked.

Associated action type: BLOCK_MESSAGE

Constraints: Maximum of 150 characters

duration_seconds: int

Timeout duration in seconds.

Associated action type: TIMEOUT

Constraints: Maximum of 2419200 seconds (4 weeks)

class discord.objects.AutoModerationRule

actions: list[AutoModerationAction]

The actions which will execute when the rule is triggered

creator_id: Snowflake

The user which first created this rule

enabled: bool

Whether the rule is enabled

event_type: AutoModerationRuleEventType

The rule event type

exempt_channels: list[Snowflake]

The channel IDs that should not be affected by the rule (maximum of 20)

exempt_roles: list[Snowflake]

The role IDs that should not be affected by the rule (maximum of 20)

guild_id: Snowflake

The ID of the guild which this rule belongs to

id: Snowflake

The ID of this rule

name: str

The rule name

trigger_metadata: AutoModerationRuleTriggerMetadata

The rule trigger metadata

trigger_type: AutoModerationRuleTriggerType

The rule trigger type

class discord.objects.AutoModerationRuleTriggerMetadata

Additional data used to determine whether a rule should be triggered. Different fields are relevant based on the value of trigger_type.

allow_list: list[str]

Substrings which should not trigger the rule (maximum of 100 or 1000).

Associated trigger types: KEYWORD, KEYWORD_PRESET, MEMBER_PROFILE

Tip

Each allow_list keyword can be a phrase which contains multiple words. Wildcard symbols can be used to customize how each keyword will be matched. Rules with KEYWORD trigger type accept a maximum of 100 keywords. Rules with KEYWORD_PRESET trigger type accept a maximum of 1000 keywords.

keyword_filter: list[str]

Substrings which will be searched for in content (maximum of 1000).

Associated trigger types: KEYWORD, MEMBER_PROFILE

Tip

A keyword can be a phrase which contains multiple words. Wildcard symbols can be used to customize how each keyword will be matched. Each keyword must be 60 characters or less.

mention_raid_protection_enabled: bool

Whether to automatically detect mention raids.

Associated trigger types: MENTION_SPAM

mention_total_limit: int

Total number of unique role and user mentions allowed per message (maximum of 50).

Associated trigger types: MENTION_SPAM

presets: list[AutoModerationRuleKeywordPresetType]

The internally pre-defined wordsets which will be searched for in content.

Associated trigger types: KEYWORD_PRESET

regex_patterns: list[str]

Regular expression patterns which will be matched against content (maximum of 10).

Associated trigger types: KEYWORD, MEMBER_PROFILE

Note

Only Rust-flavored regex is currently supported, which can be tested in online editors such as Rustexp. Each regex pattern must be 260 characters or less.

class discord.objects.AvatarDecorationData

The data for the user’s avatar decoration

asset: str

The avatar decoration hash

sku_id: Snowflake

ID of the avatar decoration’s SKU

class discord.objects.Channel

Represents a guild or DM channel within Discord.

app_permissions: Optional[PermissionFlag]

Computed permissions for the bot user in the channel, including overwrites, only included when part of the resolved data received on an interaction. This does not include implicit permissions, which may need to be checked separately

application_id: Optional[Snowflake]

Application ID of the group DM creator if it is bot-created

applied_tags: Optional[list[Snowflake]]

The IDs of the set of tags that have been applied to a thread in a GUILD_FORUM or a GUILD_MEDIA channel

available_tags: Optional[list[ForumTag]]

The set of tags that can be used in a GUILD_FORUM or a GUILD_MEDIA channel

bitrate: Optional[int]

The bitrate (in bits per second) of the voice channel

default_auto_archive_duration: Optional[int]

Default duration, copied onto newly created threads, in minutes, threads will stop showing in the channel list after the specified period of inactivity, can be set to: 60, 1440, 4320, 10080

default_forum_layout: Optional[ForumLayoutType]

The default forum layout view used to display posts in GUILD_FORUM channels. Defaults to NOT_SET, which indicates a layout view has not been set by a channel admin

default_reaction_emoji: Optional[Nullable[DefaultReaction]]

The emoji to show in the add reaction button on a thread in a GUILD_FORUM or a GUILD_MEDIA channel

default_sort_order: Optional[Nullable[DefaultSortOrderType]]

The default sort order type used to order posts in GUILD_FORUM and GUILD_MEDIA channels. Defaults to None, which indicates a preferred sort order hasn’t been set by a channel admin

default_thread_rate_limit_per_user: Optional[int]

The initial rate_limit_per_user to set on newly created threads in a channel. This field is copied to the thread at creation time and does not live update

flags: Optional[ChannelFlag]

Channel flags combined as a bitfield

guild_id: Optional[Snowflake]

The ID of the guild (may be missing for some channel objects received over gateway guild dispatches)

icon: Optional[Nullable[str]]

Icon hash of the group DM

id: Snowflake

The ID of this channel

last_message_id: Optional[Nullable[Snowflake]]

The ID of the last message sent in this channel (or thread for discord.enums.ChannelType.GUILD_FORUM or GUILD_MEDIA channels) (may not point to an existing or valid message or thread)

last_pin_timestamp: Optional[Nullable[ISO8601Timestamp]]

When the last pinned message was pinned. This may be None in events such as GUILD_CREATE when a message is not pinned

managed: Optional[bool]

For group DM channels: whether the channel is managed by an application via the gdm.join OAuth2 scope

member: Optional[ThreadMember]

Thread member object for the current user, if they have joined the thread, only included on certain API endpoints

member_count: Optional[int]

An approximate count of users in a thread, stops counting at 50

message_count: Optional[int]

Number of messages (not including the initial message or deleted messages) in a thread.

Note

For threads created before July 1, 2022, the message count is inaccurate when it’s greater than 50.

name: Optional[Nullable[str]]

The name of the channel (1-100 characters)

nsfw: Optional[bool]

Whether the channel is age-restricted

owner_id: Optional[Snowflake]

ID of the creator of the group DM or thread

parent_id: Optional[Nullable[Snowflake]]

For guild channels: ID of the parent category for a channel (each parent category can contain up to 50 channels), for threads: ID of the text channel this thread was created

permission_overwrites: Optional[list[PermissionOverwrite]]

Explicit permission overwrites for members and roles

permissions: Optional[PermissionFlag]

Computed permissions for the invoking user in the channel, including overwrites, only included when part of the resolved data received on an interaction. This does not include implicit permissions, which may need to be checked separately

position: Optional[int]

Sorting position of the channel (channels with the same position are sorted by id)

rate_limit_per_user: Optional[int]

Amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission BYPASS_SLOWMODE, are unaffected

Tip

rate_limit_per_user also applies to thread creation. Users can send one message and create one thread during each rate_limit_per_user interval.

recipients: Optional[list[User]]

The recipients of the DM

rtc_region: Optional[Nullable[str]]

Voice region ID for the voice channel, automatic when set to null

thread_metadata: Optional[ThreadMetadata]

Thread-specific fields not needed by other channels

topic: Optional[Nullable[str]]

The channel topic (0-4096 characters for GUILD_FORUM and GUILD_MEDIA channels, 0-1024 characters for all others)

total_messages_sent: Optional[int]

Number of messages ever sent in a thread, it’s similar to message_count on message creation, but will not decrement the number when a message is deleted

type: ChannelType

The type of channel

user_limit: Optional[int]

The user limit of the voice channel

video_quality_mode: Optional[VideoQualityMode]

The camera video quality mode of the voice channel, 1 when not present

class discord.objects.Collectible

The collectibles the user has, excluding Avatar Decorations and Profile Effects.

nameplate: Optional[Nameplate]

Object mapping of nameplate data

class discord.objects.DefaultReaction

An object that specifies the emoji to use as the default way to react to a forum post. Exactly one of emoji_id and emoji_name must be set

emoji_id: Nullable[Snowflake]

The ID of a guild’s custom emoji

emoji_name: Nullable[str]

The unicode character of the emoji

class discord.objects.Emoji

animated: Optional[bool]

Whether this emoji is animated

available: Optional[bool]

Whether this emoji can be used, may be False due to loss of Server Boosts

id: Nullable[Snowflake]

Emoji ID

managed: Optional[bool]

Whether this emoji is managed

name: Nullable[str]

Emoji name; can be null only in reaction emoji objects

required_colons: Optional[bool]

Whether this emoji must be wrapped in colons

roles: Optional[list[Snowflake]]

Roles allowed to use this emoji

class discord.objects.ForumTag

Represents a tag that is able to be applied to a thread in a GUILD_FORUM or GUILD_MEDIA channel.

Important

When updating a GUILD_FORUM or a GUILD_MEDIA channel, tag objects in available_tags only require the name field.

* At most one of emoji_id and emoji_name may be set to a non-null value.

emoji_id: Nullable[Snowflake]

The ID of a guild’s custom emoji

emoji_name: Nullable[str]

The unicode character of the emoji

id: Snowflake

The ID of the tag

moderated: bool

Whether this tag can only be added to or removed from threads by a member with the MANAGE_THREADS permission

name: str

The name of the tag (0-20 characters)

class discord.objects.Guild

Represents an isolated collection of users and channels, and are often referred to as “servers” in the UI.

afk_channel_id: Nullable[Snowflake]

ID of AFK channel

afk_timeout: int

AFK timeout in seconds

application_id: Nullable[Snowflake]

Application ID of the guild creator if it is bot-created

approximate_member_count: Optional[int]

Approximate number of members in this guild, retunred from the GET /guilds/<id> and /users/@me/guilds endpoints when with_counts is True

approximate_presence_count: Optional[int]

Approximate number of non-offline members in this guild, returned from the GET /guilds/<id> and /users/@me/guilds endpoints when with_counts is True

banner: Nullable[str]

Banner hash

default_message_notifications: DefaultMessageNotificationLevel

Default message notifications level

description: Nullable[str]

The description of a guild

discovery_splash: Nullable[str]

Discovery splash hash; only present for guilds with the “DISCOVERABLE” feature

emojis: list[Emoji]

Custom guild emojis

explicit_content_filter: ExplicitContentFilterLevel

Explicit content filter level

features: list[GuildFeature]

Enabled guild feature

icon: Nullable[str]

Icon hash

icon_hash: Optional[Nullable[str]]

Icon hash, returned when in the template object

id: Snowflake

Guild ID

incidents_data: Nullable[IncidentsData]

The incidents data for this guild

max_members: Optional[int]

The maximum number of members for the guild

max_presences: Optional[Nullable[int]]

The maximum number of presences for the guild (None is always returned, arapt from the largest of guilds)

max_stage_video_channel_users: Optional[int]

The maximum amount of users in a stage video channel

max_video_channel_users: Optional[int]

The maximum amount of users in a video channel

mfa_level: MFALevel

Required MFA level for the guild

name: str

Guild name (2-100 characters, excluding trailing and leading whitespace)

nsfw_level: GuildAgeRestrictionLevel

Guild age-restriction level

owner: Optional[bool]

True if the user is the owner of the guild

owner_id: Snowflake

ID of the owner.

Note

This field is only sent when using the get_current_user_guilds() endpoint and are relative to the requested user.

permissions: Optional[PermissionFlag]

Total permissiosn for the user in the guild (excludes overwrites and implicit permissions).

Note

This field is only sent when using the get_current_user_guilds() endpoint and are relative to the requested user.

preferred_locale: Locale

The preferred locale of a Community guild; used in server discovery and notices from Discord, and sent in interactions; defaults to ENGLISH_US

premium_progress_bar_enabled: bool

Whether the guild has the boost progress bar enabled

premium_subscription_count: Optional[int]

The number of boosts this guild currently has

premium_tier: PremiumTier

Premium tier (Server Boost level)

public_updates_channel_id: Nullable[Snowflake]

The ID of the channel where admins and moderators of Community guilds receive notices from Discord

region: Optional[Nullable[str]]

Voice region Id of the guild (deprecated).

Attention

This field is deprecated and is replaced by discord.objects.Channel.rtc_region.

roles: list[Role]

Roles in the guild

rules_channels_id: Nullable[Snowflake]

The ID of the channel where Community guilds can display rules and/or guidelines

safety_alerts_channel_id: Nullable[Snowflake]

The ID of the channel where admins and moderators of Community guilds receive safety alerts from Discord

splash: Nullable[str]

Splash hash

stickers: Optional[list[Sticker]]

Custom guild stickers

system_channel_flags: SystemChannelFlag

System channel flags

system_channel_id: Nullable[Snowflake]

The ID of the channel where guild notices such as welcome messages and boost events are posted

vanity_url_code: Nullable[str]

The vanity URL code for the guild

verification_level: VerificationLevel

Verification level required for the guild

welcome_screen: Optional[WelcomeScreen]

The welcome screen of a Community guild, shown to new members, returned in an Invite’s guild object

widget_channel_id: Optional[Nullable[Snowflake]]

The channel ID that the widget will generate an invite to, or None if set to no invite

widget_enabled: Optional[bool]

True if the server widget is enabled

class discord.objects.GuildApplicationCommandPermissions

Returned when fetching the permissions for an app’s command(s) in a guild.

When the id field is the application ID instead of a command ID, the permissions apply to all commands that do not contain explicit overwrites.

application_id: Snowflake

ID of the application the command belongs to

guild_id: Snowflake

ID of the guild

id: Snowflake

ID of the command or the application ID

permissions: list[ApplicationCommandPermissions]

Permissions for the command in the guild, max of 100

class discord.objects.GuildMember

Note

The field user won’t be included in the member object attached to MESSAGE_CREATE and MESSAGE_UPDATE gateway events.

Note

In GUILD_ events, pending will always be included as True or False. In non-GUILD_ events which can only be triggered by non-pending users, pending wlil not be included.

Note

Member objects retrieved from VOICE_STATE_UPDATE events will have joined_at set as None if the member was invited as a guest.

avatar: Optional[Nullable[str]]

The member’s guild avatar hash.

avatar_decoration_data: Optional[Nullable[AvatarDecorationData]]

Data for the member’s guild avatar decoration.

banner: Optional[Nullable[str]]

The member’s guild banner hash.

collectibles: Optional[Nullable[Collectible]]

Data for the member’s collectibles.

communication_disabled_until: Optional[Nullable[ISO8601Timestamp]]

When the user’s timeout will expire and the user will be able to communicate in teh guild again, null or a time in the past if the user is not timed out.

deaf: bool

Whether the user is deafened in voice channels.

flags: GuildMemberFlag

Guild member flags represented as a bit set, defaults to 0.

joined_at: Optional[ISO8601Timestamp]

When the user joined the guild.

mute: bool

Whether the user is muted in voice channels.

nick: Optional[Nullable[str]]

This user’s guild nickname.

pending: Optional[bool]

Whether the user has not yet passed the guild’s Membership Screening requirements.

permissions: Optional[PermissionFlag]

Total permissions of the member in the channel, including overwrites, returned when in the interaction object.

premium_since: Optional[Nullable[ISO8601Timestamp]]

When the user started boosting the guild.

roles: list[Snowflake]

Array of role object IDs.

user: Optional[User]

The user this guild member represents.

class discord.objects.IncidentsData

dm_spam_detected_at: Optional[Nullable[ISO8601Timestamp]]

When the dm spam was detected

dms_disabled_until: Nullable[ISO8601Timestamp]

When direct messages get enabled again

invites_disabled_until: Nullable[ISO8601Timestamp]

When invites get enabled again

raid_detected_at: Optional[Nullable[ISO8601Timestamp]]

When the raid was detected

class discord.objects.InstallParams

permissions: PermissionFlag

Permissions to request for the bot role

scopes: list[str]

Scopes to add the application to the server with

class discord.objects.Nameplate

The nameplate the user has.

asset: str

Path to the nameplate asset

label: str

The label of this nameplate. Currently unused

palette: NameplatePalette

Background color of the nameplate

sku_id: Snowflake

ID of the nameplate SKU

class discord.objects.PermissionOverwrite

allow: PermissionFlag

Permission bit set to allow

deny: PermissionFlag

Permission bit set to deny

id: Snowflake

Role or user ID

type: int

Either 0 (role) or 1 (member)

class discord.objects.Role

Roles represent a set of permissions attached to a group of users.

color: int

Deprecated. Integer representation of hexadecimal color code.

Attention

color will still be returned by the API, but using the colors field is recommended when doing requests.

colors: RoleColors

The role’s colors

flags: RoleFlag

Role flags combined as a bitfield

hoist: bool

If this role is pinned in the user listing

icon: Optional[Nullable[str]]

Role icon hash

id: Snowflake

Role ID

managed: bool

Whether this role is managed by an integration

mentionable: bool

Whether this role is mentionable

name: str

Role name

permissions: PermissionFlag

Permission bit set

position: int

Position of this role (roles with the same position are sorted by ID)

tags: Optional[RoleTags]

The tags this role has

unicode_emoji: Optional[Nullable[str]]

Role unicode emoji

class discord.objects.SessionStartLimit

max_concurrency: int

Number of identify requests allowed per 5 seconds

remaining: int

Remaining number of session starts the current user is allowed

reset_after: int

Number of milliseconds after which the limit resets

total: int

Total number of session starts the current user is allowed

class discord.Snowflake

Represents a Discord snowflake

property increment: int

For every ID that is generated on that process, this number is incremented

property internal_process_id: int

property internal_worker_id: int

property timestamp: int

Milliseconds since Discord Epoch, the first second of 2015 or 1420070400000

to_datetime() → datetime

Returns the corresponding datetime.datetime object

class discord.objects.Sticker

Represents a sticker that can be sent in messages.

available: Optional[bool]

Whether this guild sticker can be used, may be False due to loss of Server Boosts

description: Nullable[str]

Description of the sticker

format_type: StickerFormatType

Type of sticker format

guild_id: Optional[Snowflake]

ID of the guild that owns this sticker

id: Snowflake

ID of the sticker

name: str

Name of the sticker

pack_id: Optional[Snowflake]

For standard stickers, id of the pack the sticker is from

sort_value: Optional[int]

The standard sticker’s sort order within its pack

tags: list[str]

Autocomplete/suggestion tags for the sticker (max 200 characters).

Important

A comma separated list of keywords is the format used in this field by standard stickers, but this is just a convention. Incidentally the client will always use a name generated from an emoji as the value of this field when creating or modifying a guild sticker.

type: StickerType

Type of sticker

user: Optional[User]

The user that uploaded the guild sticker

class discord.objects.Team

icon: Nullable[str]

Hash of the image of the team’s icon

id: Snowflake

Unique ID of the team

members: list[TeamMember]

Members of the team

name: str

Name of the team

owner_user_id: Snowflake

User ID of the current team owner

class discord.objects.TeamMember

membership_state: MembershipState

User’s membership state on the team

role: TeamMemberRole

Role of the team member

team_id: Snowflake

ID of the parent team of which they are a member

user: User

Avatar, discriminator, ID, and username of the user

class discord.objects.ThreadMember

Contains information about a user that has joined a thread.

flags: int

Any user-thread settings, currently only used for notifications

id: Optional[Snowflake]

ID of the thread.

Note

Omitted on the member sent within each thread in the GUILD_CREATE event.

join_timestamp: ISO8601Timestamp

Time the user last joined the thread

member: Optional[GuildMember]

Additional information about the user.

Important

Only present when with_member is set to True when calling list_thread_members() or get_thread_member().

user_id: Optional[Snowflake]

ID of the user.

Note

Omitted on the member sent within each thread in the GUILD_CREATE event.

class discord.objects.ThreadMetadata

Contains number of thread-specific channel fields that are not needed by other channel types.

archive_timestamp: ISO8601Timestamp

Timestamp when the thread’s archive status was last changed, used for calculating recent activity.

archived: bool

Whether the thread is archived.

auto_archive_duration: int

The thread will stop showing in the channel list after auto_archive_duration minutes of inactivity, can be set to: 60, 1440, 4320, 10080.

create_timestamp: Optional[ISO8601Timestamp]

Timestamp when the thread was created; only populated for threads created after 2022-01-09.

invitable: Optional[bool]

Whether the non-moderators can add other non-moderators to a thread; only available on private threads.

locked: bool

Whether the thread is locked; when a thread is locked, only users with MANAGE_THREADS can unarchive it.

class discord.objects.UnavailableGuild

Represents an Offline Guild, or a Guild whose information has not been provided through Guild Create events during the Gateway connect

id: Snowflake

unavailable: bool

class discord.objects.User

Represents a Discord user

accent_color: Optional[Nullable[int]]

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

avatar: Nullable[str]

The user’s avatar hash

avatar_decoration_data: Optional[Nullable[AvatarDecorationData]]

Data for the user’s avatar decoration

banner: Optional[Nullable[str]]

The user’s banner hash

bot: Optional[bool]

Whether the user belongs to an OAuth2 application

collectibles: Optional[Nullable[Collectible]]

Data for the user’s collectibles

discriminator: str

The user’s Discord-tag

email: Optional[Nullable[str]]

The user’s email

flags: Optional[UserFlag]

The flags on a user’s account

global_name: Nullable[str]

The user’s display name, if it is set

id: Snowflake

The user’s id

locale: Optional[str]

The user’s chosen language option

mfa_enabled: Optional[bool]

Whether the user has two factor enabled on their account

premium_type: Optional[PremiumType]

The type of Nitro subscription on a user’s account

primary_guild: Optional[Nullable[UserPrimaryGuild]]

The user’s primary guild

public_flags: Optional[UserFlag]

The public flags on a user’s account

system: Optional[bool]

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

username: str

The user’s username, not unique across the platform

verified: Optional[bool]

Whether the email on this account has been verified

class discord.objects.UserPrimaryGuild

badge: Nullable[str]

The server tag badge hash

identity_enabled: Nullable[bool]

Whether the user is displaying the primary guild’s server tag. This can be None if the system clears the identity, e.g. the server no longer supports tags. This will be False if the user manually removes their tag.

identity_guild_id: Nullable[Snowflake]

The id of the user’s primary guild

tag: Nullable[str]

The text of the user’s server tag. Limited to 4 characters

class discord.objects.WelcomeScreen

description: Nullable[str]

The server description shown in the welcome screen

welcome_channels: list[WelcomeScreenChannel]

The channels shown in the welcome screen, up to 5

class discord.objects.WelcomeScreenChannel

channel_id: Snowflake

The channels’ ID

description: str

The description shown for the channel

emoji_id: Nullable[Snowflake]

The emoji ID, if the emoji is custom

emoji_name: Nullable[str]

The emoji name if custom, the unicode character if standard, or None if no emoji is set