Interface APIGuild

Hierarchy

Properties

afk_channel_id: null | string

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: null | string

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

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

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: null | string
default_message_notifications: GuildDefaultMessageNotifications
description: null | string

The description for the guild

discovery_splash: null | string

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

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

emojis: APIEmoji[]
explicit_content_filter: GuildExplicitContentFilter
features: GuildFeature[]
hub_type: null | GuildHubType

The type of Student Hub the guild is

icon: null | string
icon_hash?: null | string

Icon hash, returned when in the template object

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

id: string

Guild id

max_members?: number

The maximum number of members for the guild

max_presences?: null | number

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

max_stage_video_channel_users?: number

The maximum amount of users in a stage video channel

max_video_channel_users?: number

The maximum amount of users in a video channel

mfa_level: GuildMFALevel
name: string

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

nsfw_level: GuildNSFWLevel
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

owner_id: string

ID of owner

permissions?: string

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: string

The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to "en-US"

Default

"en-US"
premium_progress_bar_enabled: boolean

Whether the guild has the boost progress bar enabled.

premium_subscription_count?: number

The number of boosts this guild currently has

premium_tier: GuildPremiumTier
public_updates_channel_id: null | string

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

region: string

Deprecated

This field has been deprecated in favor of rtc_region on the channel.

roles: APIRole[]
rules_channel_id: null | string

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

safety_alerts_channel_id: null | string

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

splash: null | string
stickers: APISticker[]
system_channel_flags: GuildSystemChannelFlags
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: null | string

The vanity url code for the guild

verification_level: GuildVerificationLevel
welcome_screen?: APIGuildWelcomeScreen

The welcome screen of a Community guild, shown to new members

Returned in the invite object

widget_channel_id?: null | string

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

widget_enabled?: boolean

true if the guild widget is enabled

Generated using TypeDoc