interface APIGuild
extends
APIPartialGuildexport interface APIGuild extends APIPartialGuildhttps://discord.com/developers/docs/resources/guild#guild-object-guild-structure
afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600
optionalapproximate_member_count? : number
Approximate number of members in this guild, returned from the GET /guilds/<id> and /users/@me/guilds (OAuth2) endpoints when with_counts is true
optionalapproximate_presence_count? : number
Approximate number of non-offline members in this guild, returned from the GET /guilds/<id> and /users/@me/guilds (OAuth2) endpoints when with_counts is true
Banner hashSee https://discord.com/developers/docs/reference#image-formatting
default_message_notifications : GuildDefaultMessageNotifications
Default message notifications levelSee https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level
Discovery splash hash; only present for guilds with the "DISCOVERABLE" featureSee https://discord.com/developers/docs/reference#image-formatting
emojis : APIEmoji[]
Custom guild emojisSee https://discord.com/developers/docs/resources/emoji#emoji-object
explicit_content_filter : GuildExplicitContentFilter
Explicit content filter levelSee https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level
features : GuildFeature[]
Enabled guild featuresSee https://discord.com/developers/docs/resources/guild#guild-object-guild-features
hub_type : GuildHubType | null
The type of Student Hub the guild is
Icon hash, returned when in the template objectSee https://discord.com/developers/docs/reference#image-formatting
Icon hashSee https://discord.com/developers/docs/reference#image-formatting
Inherited from: APIPartialGuild
incidents_data : APIIncidentsData | null
The incidents data for this guild
optionalmax_members? : number
The maximum number of members for the guild
The maximum number of presences for the guild (null is always returned, apart from the largest of guilds)
optionalmax_stage_video_channel_users? : number
The maximum amount of users in a stage video channel
optionalmax_video_channel_users? : number
The maximum amount of users in a video channel
mfa_level : GuildMFALevel
Required MFA level for the guildSee https://discord.com/developers/docs/resources/guild#guild-object-mfa-level
name : string
Guild name (2-100 characters, excluding trailing and leading whitespace)
Inherited from: APIPartialGuild
nsfw_level : GuildNSFWLevel
The nsfw level of the guildSee https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level
owner_id : Snowflake
ID of owner
optionalowner? : boolean
true if the user is the owner of the guild**This field is only received from https://discord.com/developers/docs/resources/user#get-current-user-guilds**
optionalpermissions? : Permissions
Total permissions for the user in the guild (excludes overrides)**This field is only received from https://discord.com/developers/docs/resources/user#get-current-user-guilds**See https://en.wikipedia.org/wiki/Bit_field
preferred_locale : Locale
The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US" "en-US"
premium_progress_bar_enabled : boolean
Whether the guild has the boost progress bar enabled.
optionalpremium_subscription_count? : number
The number of boosts this guild currently has
premium_tier : GuildPremiumTier
Premium tier (Server Boost level)See https://discord.com/developers/docs/resources/guild#guild-object-premium-tier
The id of the channel where admins and moderators of Community guilds receive notices from Discord
deprecatedregion : string
This field has been deprecated in favor of rtc_region on the channel.
Voice region id for the guildSee https://discord.com/developers/docs/resources/voice#voice-region-object
roles : APIRole[]
Roles in the guildSee https://discord.com/developers/docs/topics/permissions#role-object
The id of the channel where Community guilds can display rules and/or guidelines
The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord
Splash hashSee https://discord.com/developers/docs/reference#image-formatting
Inherited from: APIPartialGuild
stickers : APISticker[]
Custom guild stickersSee https://discord.com/developers/docs/resources/sticker#sticker-object
system_channel_flags : GuildSystemChannelFlags
System channel flagsSee https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags
The id of the channel where guild notices such as welcome messages and boost events are posted
verification_level : GuildVerificationLevel
Verification level required for the guildSee https://discord.com/developers/docs/resources/guild#guild-object-verification-level
optionalwelcome_screen? : APIGuildWelcomeScreen
The welcome screen of a Community guild, shown to new membersReturned in the invite object
The channel id that the widget will generate an invite to, or null if set to no invite
optionalwidget_enabled? : boolean
true if the guild widget is enabled