APIGuild
Hierarchy
- APIPartialGuild
- APIGuild
Index
Properties
- afk_channel_id
- afk_timeout
- application_id
- approximate_member_count
- approximate_presence_count
- banner
- channels
- default_message_notifications
- description
- discovery_splash
- emojis
- explicit_content_filter
- features
- guild_scheduled_events
- icon
- icon_hash
- id
- joined_at
- large
- max_members
- max_presences
- max_video_channel_users
- member_count
- members
- mfa_level
- name
- nsfw_level
- owner
- owner_id
- permissions
- preferred_locale
- premium_progress_bar_enabled
- premium_subscription_count
- premium_tier
- presences
- public_updates_channel_id
- region
- roles
- rules_channel_id
- splash
- stage_instances
- stickers
- system_channel_flags
- system_channel_id
- unavailable
- vanity_url_code
- verification_level
- voice_states
- welcome_screen
- widget_channel_id
- widget_enabled
Properties
afk_channel_id
ID of afk channel
afk_timeout
afk timeout in seconds
application_id
Application id of the guild creator if it is bot-created
optionalapproximate_member_count
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
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
optionalchannels
Channels in the guild
This field is only sent within the GUILD_CREATE event
See https://discord.com/developers/docs/resources/channel#channel-object
default_message_notifications
Default message notifications level
description
The description for the guild, if the guild is discoverable
discovery_splash
Discovery splash hash; only present for guilds with the “DISCOVERABLE” feature
emojis
Custom guild emojis
explicit_content_filter
Explicit content filter level
features
Enabled guild features
optionalguild_scheduled_events
The scheduled events in the guild
This field is only sent within the GUILD_CREATE event
https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object
icon
optionalicon_hash
Icon hash, returned when in the template object
id
Guild id
optionaljoined_at
When this guild was joined at
This field is only sent within the GUILD_CREATE event
optionallarge
true if this is considered a large guild
This field is only sent within the GUILD_CREATE event
optionalmax_members
The maximum number of members for the guild
optionalmax_presences
The maximum number of presences for the guild (null is always returned, apart from the largest of guilds)
optionalmax_video_channel_users
The maximum amount of users in a video channel
optionalmember_count
Total number of members in this guild
This field is only sent within the GUILD_CREATE event
optionalmembers
Users in the guild
This field is only sent within the GUILD_CREATE event
See https://discord.com/developers/docs/resources/guild#guild-member-object
mfa_level
Required MFA level for the guild
name
Guild name (2-100 characters, excluding trailing and leading whitespace)
nsfw_level
The nsfw level of the guild
optionalowner
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
ID of owner
optionalpermissions
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
preferred_locale
The preferred locale of a Community guild; used in guild discovery and notices from Discord; defaults to “en-US”
premium_progress_bar_enabled
Whether the guild has the boost progress bar enabled.
optionalpremium_subscription_count
The number of boosts this guild currently has
premium_tier
Premium tier (Server Boost level)
optionalpresences
Presences of the members in the guild, will only include non-offline members if the size is greater than large_threshold
This field is only sent within the GUILD_CREATE event
See https://discord.com/developers/docs/topics/gateway#presence-update
public_updates_channel_id
The id of the channel where admins and moderators of Community guilds receive notices from Discord
region
Voice region id for the guild
roles
Roles in the guild
rules_channel_id
The id of the channel where Community guilds can display rules and/or guidelines
splash
optionalstage_instances
The stage instances in the guild
This field is only sent within the GUILD_CREATE event
stickers
Custom guild stickers
system_channel_flags
System channel flags
system_channel_id
The id of the channel where guild notices such as welcome messages and boost events are posted
optionalunavailable
true if this guild is unavailable due to an outage
vanity_url_code
The vanity url code for the guild
verification_level
Verification level required for the guild
optionalvoice_states
States of members currently in voice channels; lacks the guild_id key
This field is only sent within the GUILD_CREATE event
See https://discord.com/developers/docs/resources/voice#voice-state-object
optionalwelcome_screen
The welcome screen of a Community guild, shown to new members
Returned in the invite object
optionalwidget_channel_id
The channel id that the widget will generate an invite to, or null if set to no invite
optionalwidget_enabled
true if the guild widget is enabled
https://discord.com/developers/docs/resources/guild#guild-object-guild-structure
API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.