APIPartialGuild

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

@deprecated

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

Hierarchy

• Omit<APIUnavailableGuild, unavailable>
• Pick<APIGuild, welcome_screen>
  • APIPartialGuild
    • APIGuild

Index

Properties

• banner
• description
• features
• icon
• id
• name
• splash
• unavailable
• vanity_url_code
• verification_level
• welcome_screen

Properties

optionalbanner

banner?: null | string

Banner hash

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

optionaldescription

description?: null | string

The description for the guild, if the guild is discoverable

optionalfeatures

features?: GuildFeature[]

Enabled guild features

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

icon

icon: null | string

Icon hash

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

id

id: string

Inherited from Omit.id

Guild id

name

name: string

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

splash

splash: null | string

Splash hash

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

optionalunavailable

unavailable?: boolean

true if this guild is unavailable due to an outage

optionalvanity_url_code

vanity_url_code?: null | string

The vanity url code for the guild

optionalverification_level

verification_level?: GuildVerificationLevel

Verification level required for the guild

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

optionalwelcome_screen

welcome_screen?: APIGuildWelcomeScreen

Inherited from Pick.welcome_screen

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

Returned in the invite object