Interface APIPartialGuild

See

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

interface APIPartialGuild {
    banner?: null | string;
    description?: null | string;
    features?: GuildFeature[];
    icon: null | string;
    id: string;
    name: string;
    splash: null | string;
    vanity_url_code?: null | string;
    verification_level?: GuildVerificationLevel;
    welcome_screen?: APIGuildWelcomeScreen;
}

Hierarchy (View Summary)

Properties

banner? description? features? icon id name splash 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

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

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

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

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

Returned in the invite object

Settings

Member Visibility

On This Page

Properties