Preview environment

interface APIPartialGuild

extends

APIBaseGuild
export interface APIPartialGuild extends APIBaseGuild

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

Banner hash

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

optional
description? : string | null

The description for the guild

optional
features? : GuildFeature[]

Enabled guild features

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

icon : string | null

Icon hash

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

id : Snowflake

Guild id

Inherited from: APIBaseGuild

name : string

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

splash : string | null

Splash hash

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

optional
vanity_url_code? : string | null

The vanity url code for the guild

optional
verification_level? : GuildVerificationLevel

Verification level required for the guild

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

optional
welcome_screen? : APIGuildWelcomeScreen

The welcome screen of a Community guild, shown to new membersReturned in the invite object