Skip to main content
Version: Next

APIGuild

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

Hierarchy

Index

Properties

Properties

afk_channel_id

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

This field is only received from https://discord.com/developers/docs/resources/guild#get-guild with the with_counts query parameter set to true

optionalapproximate_presence_count

approximate_presence_count?: number

This field is only received from https://discord.com/developers/docs/resources/guild#get-guild with the with_counts query parameter set to true

banner

banner: null | string

Banner hash

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

default_message_notifications

default_message_notifications: GuildDefaultMessageNotifications

Default message notifications level

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

description

description: null | string

The description for the guild

discovery_splash

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

emojis: APIEmoji[]

Custom guild emojis

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

explicit_content_filter

explicit_content_filter: GuildExplicitContentFilter

Explicit content filter level

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

features

features: GuildFeature[]

Enabled guild features

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

hub_type

hub_type: null | GuildHubType

The type of Student Hub the guild is

icon

icon: null | string

Icon hash

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

optionalicon_hash

icon_hash?: null | string

Icon hash, returned when in the template object

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

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_video_channel_users

max_video_channel_users?: number

The maximum amount of users in a video channel

mfa_level

mfa_level: GuildMFALevel

Required MFA level for the guild

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

name

name: string

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

nsfw_level

nsfw_level: GuildNSFWLevel

The nsfw level of the guild

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

optionalowner

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

owner_id: string

ID of owner

optionalpermissions

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

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

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

Premium tier (Server Boost level)

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

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

region

region: string

Voice region id for the guild

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

@deprecated

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

roles

roles: APIRole[]

Roles in the guild

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

rules_channel_id

rules_channel_id: null | string

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

splash

splash: null | string

Splash hash

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

stickers

stickers: APISticker[]

Custom guild stickers

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

system_channel_flags

system_channel_flags: GuildSystemChannelFlags

System channel flags

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

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

optionalunavailable

unavailable?: boolean

true if this guild is unavailable due to an outage

vanity_url_code

vanity_url_code: null | string

The vanity url code for the guild

verification_level

verification_level: GuildVerificationLevel

Verification level required for the guild

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

optionalwelcome_screen

welcome_screen?: APIGuildWelcomeScreen

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

Returned in the invite object

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 guild widget is enabled