Skip to main content
GET
/
guilds
/
{guild_id}
/
preview
cURL
curl --request GET \
  --url https://discord.com/api/v10/guilds/{guild_id}/preview \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "icon": "<string>",
  "description": "<string>",
  "home_header": "<string>",
  "splash": "<string>",
  "discovery_splash": "<string>",
  "features": [
    "<string>"
  ],
  "approximate_member_count": 123,
  "approximate_presence_count": 123,
  "emojis": [
    {
      "id": "<string>",
      "name": "<string>",
      "roles": [
        "<string>"
      ],
      "require_colons": true,
      "managed": true,
      "animated": true,
      "available": true,
      "user": {
        "id": "<string>",
        "username": "<string>",
        "avatar": "<string>",
        "discriminator": "<string>",
        "public_flags": 123,
        "flags": 0,
        "global_name": "<string>",
        "primary_guild": "<unknown>",
        "bot": true,
        "system": true,
        "banner": "<string>",
        "accent_color": 123,
        "avatar_decoration_data": "<unknown>",
        "collectibles": "<unknown>"
      }
    }
  ],
  "stickers": [
    {
      "id": "<string>",
      "name": "<string>",
      "tags": "<string>",
      "type": 2,
      "format_type": "<unknown>",
      "description": "<string>",
      "available": true,
      "guild_id": "<string>",
      "user": {
        "id": "<string>",
        "username": "<string>",
        "avatar": "<string>",
        "discriminator": "<string>",
        "public_flags": 123,
        "flags": 0,
        "global_name": "<string>",
        "primary_guild": "<unknown>",
        "bot": true,
        "system": true,
        "banner": "<string>",
        "accent_color": 123,
        "avatar_decoration_data": "<unknown>",
        "collectibles": "<unknown>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Discord bot token

Path Parameters

guild_id
string<snowflake>
required

Response

200 response for get_guild_preview

id
string<snowflake>
required
name
string
required
icon
string | null
required
description
string | null
required
home_header
string | null
required
splash
string | null
required
discovery_splash
string | null
required
features
string[]
required

guild has access to set an animated guild banner image

Allowed value: "ANIMATED_BANNER"
approximate_member_count
integer<int32>
required
approximate_presence_count
integer<int32>
required
emojis
object[]
required
stickers
object[]
required