APIGuild
Hierarchy
Index
Properties
- afk_channel_id
- afk_timeout
- application_id
- approximate_member_count
- approximate_presence_count
- banner
- default_message_notifications
- description
- discovery_splash
- emojis
- explicit_content_filter
- features
- hub_type
- icon
- icon_hash
- id
- max_members
- max_presences
- max_stage_video_channel_users
- max_video_channel_users
- mfa_level
- name
- nsfw_level
- owner
- owner_id
- permissions
- preferred_locale
- premium_progress_bar_enabled
- premium_subscription_count
- premium_tier
- public_updates_channel_id
- region
- roles
- rules_channel_id
- safety_alerts_channel_id
- splash
- stickers
- system_channel_flags
- system_channel_id
- vanity_url_code
- verification_level
- welcome_screen
- widget_channel_id
- widget_enabled
Properties
afk_channel_id
ID of afk channel
afk_timeout
afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600
application_id
Application id of the guild creator if it is bot-created
optionalapproximate_member_count
Approximate number of members in this guild,
returned from the GET /guilds/<id> and /users/@me/guilds (OAuth2) endpoints when with_counts is true
optionalapproximate_presence_count
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
Banner hash
See https://discord.com/developers/docs/reference#image-formatting
default_message_notifications
Default message notifications level
See https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level
description
The description for the guild
discovery_splash
Discovery splash hash; only present for guilds with the "DISCOVERABLE" feature
See https://discord.com/developers/docs/reference#image-formatting
emojis
Custom guild emojis
See https://discord.com/developers/docs/resources/emoji#emoji-object
explicit_content_filter
Explicit content filter level
See https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level
features
Enabled guild features
See https://discord.com/developers/docs/resources/guild#guild-object-guild-features
hub_type
The type of Student Hub the guild is
icon
optionalicon_hash
Icon hash, returned when in the template object
See https://discord.com/developers/docs/reference#image-formatting
id
Guild id
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_stage_video_channel_users
The maximum amount of users in a stage video channel
optionalmax_video_channel_users
The maximum amount of users in a video channel
mfa_level
Required MFA level for the guild
See https://discord.com/developers/docs/resources/guild#guild-object-mfa-level
name
Guild name (2-100 characters, excluding trailing and leading whitespace)
nsfw_level
The nsfw level of the guild
See https://discord.com/developers/docs/resources/guild#guild-object-guild-nsfw-level
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)
See https://discord.com/developers/docs/resources/guild#guild-object-premium-tier
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
See https://discord.com/developers/docs/resources/voice#voice-region-object
roles
Roles in the guild
See https://discord.com/developers/docs/topics/permissions#role-object
rules_channel_id
The id of the channel where Community guilds can display rules and/or guidelines
safety_alerts_channel_id
The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord
splash
Splash hash
See https://discord.com/developers/docs/reference#image-formatting
stickers
Custom guild stickers
See https://discord.com/developers/docs/resources/sticker#sticker-object
system_channel_flags
System channel flags
See https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags
system_channel_id
The id of the channel where guild notices such as welcome messages and boost events are posted
vanity_url_code
The vanity url code for the guild
verification_level
Verification level required for the guild
See https://discord.com/developers/docs/resources/guild#guild-object-verification-level
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