Skip to main content
GET
/
guilds
/
{guild_id}
/
widget.json
cURL
curl --request GET \
  --url https://discord.com/api/v10/guilds/{guild_id}/widget.json \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "instant_invite": "<string>",
  "channels": [
    {
      "id": "<string>",
      "name": "<string>",
      "position": 123
    }
  ],
  "members": [
    {
      "id": "<string>",
      "username": "<string>",
      "discriminator": "<string>",
      "avatar": "<unknown>",
      "status": "<string>",
      "avatar_url": "<string>",
      "activity": {
        "name": "<string>"
      },
      "deaf": true,
      "mute": true,
      "self_deaf": true,
      "self_mute": true,
      "suppress": true,
      "channel_id": "<string>"
    }
  ],
  "presence_count": 123
}

Authorizations

Authorization
string
header
required

Discord bot token

Path Parameters

guild_id
string<snowflake>
required

Response

200 response for get_guild_widget

id
string<snowflake>
required
name
string
required
instant_invite
string | null
required
channels
object[]
required
members
object[]
required
presence_count
integer<int32>
required