--- title: "GET /guilds/{guild_id}/preview" method: GET path: "/guilds/{guild_id}/preview" --- # GET /guilds/{guild_id}/preview `GET /guilds/{guild_id}/preview` ## Response `200` 200 response for get_guild_preview - GuildPreviewResponse - `id` string, snowflake, required - `name` string, required - `icon` string, nullable, required - `description` string, nullable, required - `home_header` string, nullable, required - `splash` string, nullable, required - `discovery_splash` string, nullable, required - `features` GuildFeatures[], required - union - 'ANIMATED_BANNER' — guild has access to set an animated guild banner image - 'ANIMATED_ICON' — guild has access to set an animated guild icon - 'APPLICATION_COMMAND_PERMISSIONS_V2' — guild is using the old permissions configuration behavior - 'AUTO_MODERATION' — guild has set up auto moderation rules - 'BANNER' — guild has access to set a guild banner image - 'COMMUNITY' — guild can enable welcome screen, Membership Screening, stage channels and discovery, and receives community updates - 'CREATOR_MONETIZABLE_PROVISIONAL' — guild has enabled monetization - 'CREATOR_STORE_PAGE' — guild has enabled the role subscription promo page - 'DEVELOPER_SUPPORT_SERVER' — guild has been set as a support server on the App Directory - 'DISCOVERABLE' — guild is able to be discovered in the directory - 'FEATURABLE' — guild is able to be featured in the directory - 'INVITES_DISABLED' — guild has paused invites, preventing new users from joining - 'INVITE_SPLASH' — guild has access to set an invite splash background - 'MEMBER_VERIFICATION_GATE_ENABLED' — guild has enabled Membership Screening - 'MORE_STICKERS' — guild has increased custom sticker slots - 'NEWS' — guild has access to create announcement channels - 'PARTNERED' — guild is partnered - 'PREVIEW_ENABLED' — guild can be previewed before joining via Membership Screening or the directory - 'RAID_ALERTS_DISABLED' — guild has disabled activity alerts in the configured safety alerts channel - 'PRUNE_REQUIRES_ADMIN' — guild has restricted member prune to administrators and the guild owner - 'ROLE_ICONS' — guild is able to set role icons - 'ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE' — guild has role subscriptions that can be purchased - 'ROLE_SUBSCRIPTIONS_ENABLED' — guild has enabled role subscriptions - 'TICKETED_EVENTS_ENABLED' — guild has enabled ticketed events - 'VANITY_URL' — guild has access to set a vanity URL - 'VERIFIED' — guild is verified - 'VIP_REGIONS' — guild has access to set 384kbps bitrate in voice (previously VIP voice servers) - 'WELCOME_SCREEN_ENABLED' — guild has enabled the welcome screen - 'OFFICIAL_GAME_GUILD' — guild is an official guild for one or more games - `approximate_member_count` integer, required - `approximate_presence_count` integer, required - `emojis` EmojiResponse[], required - `id` string, snowflake, required - `name` string, required - `user` UserResponse - `id` string, snowflake, required - `username` string, required — the user's username, not unique across the platform - `avatar` string, nullable, required — the user's avatar hash - `discriminator` string, required — the user's Discord-tag - `public_flags` integer, required — the public flags on a user's account - `flags` integer, required - `bot` boolean — whether the user belongs to an OAuth2 application - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system) - `banner` string, nullable — the user's banner hash - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code - `global_name` string, nullable, required — the user's display name, if it is set - `avatar_decoration_data` UserAvatarDecorationResponse - `asset` string, required — the avatar decoration hash - `sku_id` string, snowflake, required - `collectibles` UserCollectiblesResponse - `nameplate` UserNameplateResponse, required - `sku_id` string, snowflake, required - `asset` string, required — Path to the nameplate asset - `label` string, required — The label of this nameplate. Currently unused - `palette` union, required - 'crimson' — Crimson color palette - 'berry' — Berry color palette - 'sky' — Sky color palette - 'teal' — Teal color palette - 'forest' — Forest color palette - 'bubble_gum' — Bubble gum color palette - 'violet' — Violet color palette - 'cobalt' — Cobalt color palette - 'clover' — Clover color palette - 'lemon' — Lemon color palette - 'white' — White color palette - 'black' — Black color palette - `primary_guild` UserPrimaryGuildResponse, required - `identity_guild_id` string, snowflake, required - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters - `badge` string, nullable, required — the server tag badge hash - `roles` SnowflakeType[], required - `require_colons` boolean, required - `managed` boolean, required - `animated` boolean, required - `available` boolean, required - `stickers` GuildStickerResponse[], required - `id` string, snowflake, required - `name` string, required - `tags` string, required - `type` union, required - 1 — an official sticker in a pack, part of Nitro or in a removed purchasable pack - 2 — a sticker uploaded to a guild for the guild's members - `format_type` union, required - 1 - 2 - 3 - 4 - `description` string, nullable, required - `available` boolean, required - `guild_id` string, snowflake, required - `user` UserResponse - `id` string, snowflake, required - `username` string, required — the user's username, not unique across the platform - `avatar` string, nullable, required — the user's avatar hash - `discriminator` string, required — the user's Discord-tag - `public_flags` integer, required — the public flags on a user's account - `flags` integer, required - `bot` boolean — whether the user belongs to an OAuth2 application - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system) - `banner` string, nullable — the user's banner hash - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code - `global_name` string, nullable, required — the user's display name, if it is set - `avatar_decoration_data` UserAvatarDecorationResponse - `asset` string, required — the avatar decoration hash - `sku_id` string, snowflake, required - `collectibles` UserCollectiblesResponse - `nameplate` UserNameplateResponse, required - `sku_id` string, snowflake, required - `asset` string, required — Path to the nameplate asset - `label` string, required — The label of this nameplate. Currently unused - `palette` union, required - 'crimson' — Crimson color palette - 'berry' — Berry color palette - 'sky' — Sky color palette - 'teal' — Teal color palette - 'forest' — Forest color palette - 'bubble_gum' — Bubble gum color palette - 'violet' — Violet color palette - 'cobalt' — Cobalt color palette - 'clover' — Clover color palette - 'lemon' — Lemon color palette - 'white' — White color palette - 'black' — Black color palette - `primary_guild` UserPrimaryGuildResponse, required - `identity_guild_id` string, snowflake, required - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters - `badge` string, nullable, required — the server tag badge hash ## Other responses - `429` — Client ratelimited response - `4XX` — Client error response ## Changes - **2026-06-23** `9d9835a65e9c` — 1 breaking - added `subschema #20: PRUNE_REQUIRES_ADMIN` to the `features/items/` response property `oneOf` list for the response status `200` - **2026-06-05** `693bf1f99bba` — 2 breaking - added `subschema #1: CRIMSON, subschema #2: BERRY, subschema #3: SKY, subschema #4: TEAL, subschema #5: FOREST, subschema #6: BUBBLE_GUM, subschema #7: VIOLET, subschema #8: COBALT, subschema #9: CLOVER, subschema #10: LEMON, subschema #11: WHITE, subschema #12: BLACK` to the `emojis/items/user/collectibles/oneOf[#/components/schemas/UserCollectiblesResponse]/nameplate/oneOf[#/components/schemas/UserNameplateResponse]/palette` response property `oneOf` list for the response status `200` - added `subschema #1: CRIMSON, subschema #2: BERRY, subschema #3: SKY, subschema #4: TEAL, subschema #5: FOREST, subschema #6: BUBBLE_GUM, subschema #7: VIOLET, subschema #8: COBALT, subschema #9: CLOVER, subschema #10: LEMON, subschema #11: WHITE, subschema #12: BLACK` to the `stickers/items/user/collectibles/oneOf[#/components/schemas/UserCollectiblesResponse]/nameplate/oneOf[#/components/schemas/UserNameplateResponse]/palette` response property `oneOf` list for the response status `200` - **2026-03-05** `b65faa7e80e9` — 1 breaking - added `subschema #28: OFFICIAL_GAME_GUILD` to the `features/items/` response property `oneOf` list for the response status `200` - …earlier changes not shown [Full history](https://skmtc.dev/discord/apis/discord-http-api-preview/changes/guilds/:guild_id/preview/get.md) --- [API](https://skmtc.dev/discord/apis/discord-http-api-preview.md) · [All operations](https://skmtc.dev/discord/apis/discord-http-api-preview/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/discord/discord-http-api-preview/revisions/49efa428e0dd/schema)