Preview environment

interface APIGuild

export interface APIGuild extends APIPartialGuild

See also: https://discord.com/developers/docs/resources/guild#guild-object-guild-structure

afk_channel_id : Snowflake | null

ID of afk channel

afk_timeout : 1800 | 3600 | 60 | 300 | 900

afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600

application_id : Snowflake | null

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

optional
approximate_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

optional
approximate_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 hash

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

default_message_notifications : GuildDefaultMessageNotifications

Default message notifications level

See also: https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level

description : string | null

The description for the guild

discovery_splash : string | null

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

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

emojis : APIEmoji[]

Custom guild emojis

See also: https://discord.com/developers/docs/resources/emoji#emoji-object

explicit_content_filter : GuildExplicitContentFilter

Explicit content filter level

See also: https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level

features : GuildFeature[]

Enabled guild features

See also: https://discord.com/developers/docs/resources/guild#guild-object-guild-features

hub_type : GuildHubType | null

The type of Student Hub the guild is

optional
icon_hash? : string | null

Icon hash, returned when in the template object

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

icon : string | null

Icon hash

Inherited from: APIPartialGuild

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

incidents_data : APIIncidentsData | null

The incidents data for this guild

optional
max_members? : number

The maximum number of members for the guild

optional
max_presences? : number | null

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

optional
max_stage_video_channel_users? : number

The maximum amount of users in a stage video channel

optional
max_video_channel_users? : number

The maximum amount of users in a video channel

mfa_level : GuildMFALevel

Required MFA level for the guild

See also: 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 guild

See also: https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level

owner_id : Snowflake

ID of owner

optional
owner? : 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**

optional
permissions? : 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 also: 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"

premium_progress_bar_enabled : boolean

Whether the guild has the boost progress bar enabled.

optional
premium_subscription_count? : number

The number of boosts this guild currently has

premium_tier : GuildPremiumTier

Premium tier (Server Boost level)

See also: https://discord.com/developers/docs/resources/guild#guild-object-premium-tier

public_updates_channel_id : Snowflake | null

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

deprecated
region : string

Voice region id for the guild

See also: https://discord.com/developers/docs/resources/voice#voice-region-object

roles : APIRole[]

Roles in the guild

See also: https://discord.com/developers/docs/topics/permissions#role-object

rules_channel_id : Snowflake | null

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

safety_alerts_channel_id : Snowflake | null

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

splash : string | null

Splash hash

Inherited from: APIPartialGuild

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

stickers : APISticker[]

Custom guild stickers

See also: https://discord.com/developers/docs/resources/sticker#sticker-object

system_channel_flags : GuildSystemChannelFlags

System channel flags

See also: https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags

system_channel_id : Snowflake | null

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

vanity_url_code : string | null

The vanity url code for the guild

verification_level : GuildVerificationLevel

Verification level required for the guild

See also: https://discord.com/developers/docs/resources/guild#guild-object-verification-level

optional
welcome_screen? : APIGuildWelcomeScreen

The welcome screen of a Community guild, shown to new membersReturned in the invite object

optional
widget_channel_id? : Snowflake | null

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

optional
widget_enabled? : boolean

true if the guild widget is enabled