Skip to main content
Module

x/discord_api_types/v10.ts>APIGuild

Up to date Discord API Typings, versioned by the API version
discordjs/discord-api-types
Go to Latest
interface APIGuild
implements APIPartialGuild
Re-export
import { type APIGuild } from "https://deno.land/x/discord_api_types@0.37.11/v10.ts";

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

Properties

optional
icon_hash: string | null

Icon hash, returned when in the template object

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

discovery_splash: string | null

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

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

optional
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: Snowflake

ID of owner

optional
permissions: Permissions

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

deprecated
region: string

Voice region id for the guild

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

afk_channel_id: Snowflake | null

ID of afk channel

afk_timeout: number

afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600

optional
widget_enabled: boolean

true if the guild widget is enabled

optional
widget_channel_id: Snowflake | null

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

explicit_content_filter: GuildExplicitContentFilter

Explicit content filter level

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

application_id: Snowflake | null

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

system_channel_id: Snowflake | null

The id of the channel where guild notices such as welcome messages and boost events are posted

rules_channel_id: Snowflake | null

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

optional
max_presences: number | null

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

optional
max_members: number

The maximum number of members for the guild

vanity_url_code: string | null

The vanity url code for the guild

description: string | null

The description for the guild

optional
premium_subscription_count: number

The number of boosts this guild currently has

preferred_locale: string

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

public_updates_channel_id: Snowflake | null

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

optional
max_video_channel_users: number

The maximum amount of users in a video channel

optional
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

optional
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

optional
welcome_screen: APIGuildWelcomeScreen

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

Returned in the invite object

premium_progress_bar_enabled: boolean

Whether the guild has the boost progress bar enabled.

hub_type: GuildHubType | null

The type of Student Hub the guild is