Skip to main content

APIGuild

Index

Properties

afk_channel_id

afk_channel_id: string

ID of AFK channel

afk_timeout

afk_timeout: number

AFK timeout in seconds

application_id

application_id: null | string

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

optionalapproximate_member_count

approximate_member_count?: number

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

optionalapproximate_presence_count

approximate_presence_count?: number

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

banner: null | string

default_message_notifications

default_message_notifications: MessageNotificationLevel

description

description: null | string

The description of the guild

discovery_splash

discovery_splash: null | string

Discovery splash hash; only present for guilds with the Discoverable feature

emojis

emojis: APIEmoji[]

Custom guild emojis

explicit_content_filter

explicit_content_filter: number

features

features: GuildFeature[]

Enabled guild features

icon

icon: null | string

optionaliconHash

iconHash?: null | string

Icon hash, returned when in the template object

@see

id

id: string

Guild ID

optionalmax_members

max_members?: number

The maximum number of members for the guild

optionalmax_presences

max_presences?: null | number

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

optionalmax_stage_video_channel_users

max_stage_video_channel_users?: number

The maximum amount of users in a stage video channel

optionalmax_video_channel_users

max_video_channel_users?: number

The maximum amount of users in a video channel

mfa_level

mfa_level: MfaLevel

name

name: string

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

nsfw_level

nsfw_level: GuildNSFWLevel

optionalowner

owner?: boolean

true if the user is the owner of the guild

Only sent when using the Current User Guilds endpoint and are relative to the requested user

@see

owner_id

owner_id: string

ID of owner

optionalpermissions

permissions?: string

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

Only sent when using the Current User Guilds endpoint and are relative to the requested user

@see

preferred_locale

preferred_locale: string

The preferred locale of a Community guild; used in server discovery and notices from Discord, and sent in interactions; defaults to “en-US”

@see

premium_progress_bar_enabled

premium_progress_bar_enabled: boolean

Whether the guild has the boost progress bar enabled

optionalpremium_subscription_count

premium_subscription_count?: number

The number of boosts this guild currently has

premium_tier

premium_tier: PremiumTier

public_updates_channel_id

public_updates_channel_id: null | string

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

optionalregion

region?: string

roles

roles: APIRole[]

Roles in the guild

rules_channel_id

rules_channel_id: null | string

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

safety_alerts_channel_id

safety_alerts_channel_id: null | string

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

splash

splash: null | string

optionalstickers

stickers?: APISticker[]

Custom guild stickers

system_channel_flags

system_channel_flags: SystemChannelFlags

system_channel_id

system_channel_id: null | string

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

vanity_url_code

vanity_url_code: null | string

The vanity url code for the guild

verification_level

verification_level: VerificationLevel

optionalwelcome_screen

welcome_screen?: APIWelcomeScreen

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

@see

optionalwidget_channel_id

widget_channel_id?: null | string

The channel id that the widget will generate an invite to, or null if set to no invite

optionalwidget_enabled

widget_enabled?: boolean

true if the server widget is enabled