Skip to main content
Version: Next

APIGuild

@deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

Hierarchy

Index

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

optionalchannels

channels?: APIChannel[]

Channels in the guild

default_message_notifications

default_message_notifications: GuildDefaultMessageNotifications

description

description: null | string

The description for the guild, if the guild is discoverable

discovery_splash

discovery_splash: null | string

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

emojis

emojis: APIEmoji[]

explicit_content_filter

explicit_content_filter: GuildExplicitContentFilter

features

features: GuildFeature[]

optionalguild_scheduled_events

guild_scheduled_events?: APIGuildScheduledEvent[]

The scheduled events in the guild

icon

icon: null | string

optionalicon_hash

icon_hash?: null | string

Icon hash, returned when in the template object

id

id: string

Guild id

optionaljoined_at

joined_at?: string

When this guild was joined at

This field is only sent within the GUILD_CREATE event

optionallarge

large?: boolean

true if this is considered a large guild

This field is only sent within the GUILD_CREATE event

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

optionalmember_count

member_count?: number

Total number of members in this guild

This field is only sent within the GUILD_CREATE event

optionalmembers

members?: APIGuildMember[]

Users in the guild

mfa_level

mfa_level: GuildMFALevel

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

owner_id

owner_id: string

ID of owner

optionalpermissions

permissions?: string

Total permissions for the user in the guild (excludes overrides)

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

optionalpresences

presences?: GatewayPresenceUpdate[]

Presences of the members in the guild, will only include non-offline members if the size is greater than large_threshold

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

@deprecated

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

roles

roles: APIRole[]

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

optionalstage_instances

stage_instances?: APIStageInstance[]

stickers

stickers: APISticker[]

system_channel_flags

system_channel_flags: GuildSystemChannelFlags

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

optionalvoice_states

voice_states?: Omit<GatewayVoiceState, guild_id>[]

States of members currently in voice channels; lacks the guild_id key

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