Interface

APIGuild

Full guild object from GET /guilds/{id} or gateway GUILD_CREATE.

Properties

afk_channel_id?: Snowflake | null

AFK voice channel ID.

afk_timeout: number

AFK timeout in seconds.

approximate_member_count?: number

Approximate member count when `with_counts` is set on guild list.

approximate_presence_count?: number

Approximate online count when `with_counts` is set on guild list.

channels?: APIChannel[]

Channels when included in a gateway/REST guild payload.

content_warning_level: ContentWarningLevel

Content warning level (see ContentWarningLevel).

content_warning_text?: string | null

Custom guild-wide content warning text.

default_message_notifications: DefaultMessageNotifications

Default notification level (see DefaultMessageNotifications).

disabled_operations: number

GuildOperations bitfield of disabled operations.

embed_splash?: string | null

Embed splash image hash (deprecated).

embed_splash_height?: number | null

Embed splash height in pixels.

embed_splash_width?: number | null

Embed splash width in pixels.

emojis?: APIEmoji[]

Emojis when included in a gateway/REST guild payload.

explicit_content_filter: GuildExplicitContentFilter

Explicit content filter level (see GuildExplicitContentFilter).

features: GuildFeature[]

Guild feature flags (see GuildFeature).

icon?: string | null

Guild icon hash.

Guild ID.

member_count?: number

Member count when included (gateway / guild payloads).

message_history_cutoff?: string | null

ISO-8601 timestamp before which message history is not available.

mfa_level: GuildMFALevel

MFA requirement level (see GuildMFALevel).

name: string

Guild name.

nsfw: boolean

Whether the guild is marked as adult (18+) content.

nsfw_level: GuildNSFWLevel

NSFW level (see GuildNSFWLevel).

online_count?: number

Online member count when included (gateway / guild payloads).

owner_id: Snowflake

Guild owner user ID.

permissions?: string

Permissions for the current user in this guild (bitfield string).

roles?: APIRole[]

Roles when included in a gateway/REST guild payload.

rules_channel_id?: Snowflake | null

Rules channel ID.

splash?: string | null

Invite splash image hash.

splash_card_alignment: SplashCardAlignment

Splash card alignment (see SplashCardAlignment).

splash_height?: number | null

Splash height in pixels.

splash_width?: number | null

Splash width in pixels.

stickers?: APISticker[]

Stickers when included in a gateway/REST guild payload.

system_channel_flags: number

SystemChannelFlags bitfield.

system_channel_id?: Snowflake | null

System channel ID (join/boost messages).

vanity_url_code?: string | null

Custom vanity URL code.

verification_level: GuildVerificationLevel

Verification level (see GuildVerificationLevel).