Get Discord server

GET/v1/discord/servers/{serverId}

1credit

Headers

x-api-keystringheader

API key (`sfk_...`)

Parameters

serverIdstringrequiredpath

Server id, 17 to 20 digits and at most 9223372036854775807, e.g. `267624335836053506`. A server with no public page or subscription store page returns `not_found`.

pattern: ^[0-9]{17,20}$

includearrayoptionalquery

`widget` adds the public guild widget summary. Default: none.

any of: widget (comma-separated)

announcementsbooleanoptionalquery

Include the announcement channels for this server. Default: true.

Response fields

179

Endpoint-specific response payload.

datalookupStatus

string

`not_found` when the id is not a server in the public directory (the id may still be a server with no directory page).

one of: found, not_found, restricted

datareason

stringnullable

`not_listed` when the id has no public directory page; null when found.

one of: not_listed, null

datalisted

boolean

True for a directory server page; false for a subscription store page.

The server when found; null otherwise.

dataserverid

string

Server id.

dataservername

string

Server name.

dataserverdescription

stringnullable

Short description shown in the directory.

dataservericonUrl

stringnullable

Server icon URL.

dataserversplashUrl

stringnullable

Invite splash URL.

dataserverdiscoverySplashUrl

stringnullable

Discovery splash URL.

dataserverbannerUrl

stringnullable

Banner URL.

dataservercustomBannerUrl

stringnullable

Custom invite banner URL, when a working image path is known.

dataservercustomBannerHash

stringnullable

The custom invite banner hash. No image URL is available for it.

dataservermembers

integernullable

Member count; live on an invite, indexed elsewhere.

dataserveronline

integernullable

Online member count; live on an invite, indexed elsewhere.

dataservercountsAsOf

stringnullable

Whether `members` and `online` are live or indexed.

one of: live, index, null

Boost count and tier, when present.

dataserverboostscount

integernullable

Boost count.

dataserverbooststier

integernullable

Boost tier.

dataserverlocale

stringnullable

The server's preferred locale, e.g. `en-US`.

dataserververificationLevel

stringnullable

The server's verification level.

one of: none, low, medium, high, very_high, unknown, null

dataserverageRestricted

booleannullable

Whether the server is age-restricted.

dataservernsfwLevel

integernullable

Discord's NSFW level value.

dataservervanityCode

stringnullable

The server's vanity invite code, when it has one.

dataservertag

stringnullable

The server tag shown on the invite card.

The server tag's badge, when it has one.

dataservertagBadgeid

integernullable

Discord's badge id.

dataservertagBadgehash

stringnullable

Badge image hash.

dataservertagBadgeurl

stringnullable

Badge image URL.

Badge colours as hex strings.

dataservertagBadgecolorsprimary

stringnullable

Primary badge colour.

dataservertagBadgecolorssecondary

stringnullable

Secondary badge colour.

dataserverbrandColor

stringnullable

The invite card's brand colour.

Labels the server shows on its invite card.

dataservertraits[]label

string

The trait label.

dataservertraits[]emojiName

stringnullable

Emoji name shown with the trait, or null.

dataservertraits[]emojiId

stringnullable

Custom emoji id shown with the trait, or null.

dataservertraits[]emojiAnimated

booleannullable

Whether the custom emoji is animated; null when absent.

Games the invite card shows for this server.

dataservergames[]applicationId

string

The game's application id.

dataservergames[]activityLevel

integernullable

How active the game is on the server, as Discord ranks it.

dataservergames[]activityScore

numbernullable

Discord's activity score for the game on the server.

The server's feature flags, passed through.

dataserverfeatures[]

stringoptional

Feature flags from the invite card's profile block, when present.

dataserverprofileFeatures[]

stringoptional

dataserverprofileVisibility

integernullable

The invite card profile visibility value, when given.

dataserverflags

integernullable

The invite's public flags value, when given.

dataservernsfwProperties

objectnullable

The server's age-gate properties, passed through.

Search keywords listed for the server.

dataserverkeywords[]

stringoptional

Directory categories the server belongs to.

dataservercategories[]id

integer

Category id.

dataservercategories[]name

stringnullable

Category name; null when unknown.

dataservercategories[]isPrimary

booleannullable

True on `primaryCategory`, which is primary by definition. On a list entry, whether it is the server's primary category, or null when the page names no primary.

dataservercategories[]nameLocalizations

objectnullable

Localised category names, keyed by locale, passed through.

The server's primary directory category.

dataserverprimaryCategoryid

integer

Category id.

dataserverprimaryCategoryname

stringnullable

Category name; null when unknown.

dataserverprimaryCategoryisPrimary

booleannullable

True on `primaryCategory`, which is primary by definition. On a list entry, whether it is the server's primary category, or null when the page names no primary.

dataserverprimaryCategorynameLocalizations

objectnullable

Localised category names, keyed by locale, passed through.

dataservercreatedAt

stringnullable

When the server was created, ISO 8601 UTC.

Reasons to join that the server lists.

dataserverreasonsToJoin[]text

string

The reason text.

dataserverreasonsToJoin[]emojiName

stringnullable

Emoji name, or null.

dataserverreasonsToJoin[]emojiId

stringnullable

Custom emoji id, or null.

Social links the server lists.

dataserversocialLinks[]

stringoptional

dataserverabout

stringnullable

The server's long about text.

Directory category ids the server lists.

dataservercategoryIds[]

integeroptional

The server's permanent invite.

datainvitecode

string

The permanent invite code.

datainviteurl

string

The invite URL.

The channel the invite lands in.

datainvitechannelid

string

Channel id.

datainvitechannelname

stringnullable

Channel name.

Paid-tier data when the server has a subscription store page.

datasubscriptionsstoreDescription

stringnullable

The store page's description.

The store page's cover image.

datasubscriptionscoverImageid

stringnullable

Asset id.

datasubscriptionscoverImagesize

integernullable

Asset size in bytes.

datasubscriptionscoverImagemimeType

stringnullable

MIME type.

datasubscriptionscoverImagewidth

integernullable

Width in pixels.

datasubscriptionscoverImageheight

integernullable

Height in pixels.

datasubscriptionscoverImageapplicationId

stringnullable

Application id.

datasubscriptionscoverImageUrl

stringnullable

Cover image URL built from the asset id, application id and the store asset path.

datasubscriptionstrailerUrl

stringnullable

Store page trailer URL.

datasubscriptionsprimaryColor

stringnullable

Store page brand colour.

A second permanent invite, used for the subscription purchase flow.

datasubscriptionspurchaseInvitecode

string

The permanent invite code.

datasubscriptionspurchaseInviteurl

string

The invite URL.

The channel the invite lands in.

datasubscriptionspurchaseInvitechannelid

string

Channel id.

datasubscriptionspurchaseInvitechannelname

stringnullable

Channel name.

datasubscriptionssubscriberCount

integernullable

Subscriber count; null when the owner hides it.

Paid groups.

datasubscriptionsgroups[]id

string

Group id.

datasubscriptionsgroups[]name

string

Group name.

datasubscriptionsgroups[]description

stringnullable

Group description.

datasubscriptionsgroups[]applicationId

stringnullable

Application id.

Tiers in this group.

datasubscriptionsgroups[]tiers[]name

string

Tier name.

datasubscriptionsgroups[]tiers[]description

stringnullable

Tier description.

datasubscriptionsgroups[]tiers[]imageUrl

stringnullable

Tier image URL.

datasubscriptionsgroups[]tiers[]roleId

stringnullable

The role the tier grants.

datasubscriptionsgroups[]tiers[]published

booleannullable

Whether the tier is published.

datasubscriptionsgroups[]tiers[]archived

booleannullable

Whether the tier is archived.

The tier's price.

datasubscriptionsgroups[]tiers[]priceamount

integernullable

Price in minor units.

datasubscriptionsgroups[]tiers[]pricecurrency

stringnullable

Currency code.

datasubscriptionsgroups[]tiers[]priceinterval

integernullable

Billing interval.

datasubscriptionsgroups[]tiers[]priceintervalCount

integernullable

Interval length.

datasubscriptionsgroups[]tiers[]pricetaxInclusive

booleannullable

Whether the price includes tax.

datasubscriptionsgroups[]tiers[]storePrices

objectnullable

Per-country prices, passed through.

Benefits attached to the tier.

datasubscriptionsgroups[]tiers[]benefits[]text

stringnullable

Benefit description.

datasubscriptionsgroups[]tiers[]benefits[]emojiName

stringnullable

Emoji name.

datasubscriptionsgroups[]tiers[]benefits[]emojiId

stringnullable

Custom emoji id.

datasubscriptionsgroups[]tiers[]benefits[]type

integernullable

Discord's benefit reference type.

datasubscriptionsgroups[]tiers[]benefits[]channelId

stringnullable

The channel the benefit refers to, when it does.

Free-trial terms, when the tier has them.

datasubscriptionsgroups[]tiers[]trialdays

integernullable

Trial length in days.

datasubscriptionsgroups[]tiers[]trialmaxUsers

integernullable

Maximum trial users; null when uncapped.

datasubscriptionsgroups[]tiers[]trialactiveUsers

integernullable

Users on the trial now.

Free trials the subscription store offers. They apply to the whole store, so they are not attached to one tier.

datasubscriptionstrials[]days

integernullable

Trial length in days.

datasubscriptionstrials[]maxUsers

integernullable

Maximum trial users; null when uncapped.

datasubscriptionstrials[]activeUsers

integernullable

Users on the trial now.

Channels open only to subscribers.

datasubscriptionsbenefitChannels[]id

string

Channel id.

datasubscriptionsbenefitChannels[]name

string

Channel name.

datasubscriptionsbenefitChannels[]type

integernullable

Channel type.

Emojis available only to subscribers.

datasubscriptionsbenefitEmojis[]name

stringnullable

Emoji name.

datasubscriptionsbenefitEmojis[]id

stringnullable

Emoji id.

datasubscriptionsbenefitEmojis[]animated

booleannullable

Whether the emoji is animated.

Announcement channels, or null when `announcements=false` or the page is a store page.

Announcement channels for this server.

dataannouncementschannels[]id

string

Channel id.

dataannouncementschannels[]name

stringnullable

Channel name.

dataannouncementschannels[]topic

stringnullable

Channel topic.

Public posts in the channel.

dataannouncementschannels[]messages[]id

string

Message id.

dataannouncementschannels[]messages[]text

string

The message text.

dataannouncementschannels[]messages[]postedAt

stringnullable

When it was posted, ISO 8601 UTC.

dataannouncementschannels[]messages[]editedAt

stringnullable

When it was edited, ISO 8601 UTC; null when never edited.

Files attached to the post.

dataannouncementschannels[]messages[]attachments[]url

string

The attachment URL. Its signed query parameters expire, so the link is time-limited.

dataannouncementschannels[]messages[]attachments[]mediaUrl

stringnullableoptional

A second URL for the attachment on Discord's media host, when present.

dataannouncementschannels[]messages[]attachments[]contentType

stringnullable

MIME type, when given.

dataannouncementschannels[]messages[]attachments[]width

integernullable

Width in pixels, when given.

dataannouncementschannels[]messages[]attachments[]height

integernullable

Height in pixels, when given.

dataannouncementschannels[]messages[]attachments[]description

stringnullable

Alt text, when present.

Reactions on the post.

dataannouncementschannels[]messages[]reactions[]emojiId

stringnullable

Custom emoji id, or null.

dataannouncementschannels[]messages[]reactions[]emojiName

stringnullable

Emoji name, or null.

dataannouncementschannels[]messages[]reactions[]animated

booleannullable

Whether the emoji is animated.

dataannouncementschannels[]messages[]reactions[]count

integer

How many people reacted.

The widget summary when `include=widget` was asked for.

datawidgetenabled

boolean

Whether the server's widget is enabled.

The server the widget names.

datawidgetserverid

string

Server id.

datawidgetservername

stringnullable

Server name.

datawidgetonline

integernullable

The exact online count, not capped at the member sample.

The temporary invite the widget shows.

datawidgetinvitecode

string

The temporary invite code.

datawidgetinviteurl

string

The invite URL.

datawidgetinvitetemporary

boolean

The widget invite is temporary; its code expires within hours, not never.

Public voice channels.

datawidgetvoiceChannels[]id

string

Channel id.

datawidgetvoiceChannels[]name

string

Channel name.

datawidgetvoiceChannels[]position

integernullable

Channel position.

datawidgetonlineSampleSize

integer

Number of online members in the sample (at most 100). The members themselves are not returned.

Metadata describing the request and billing outcome.

metarequestId

string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged

integer

Credits charged for this request.

≥ 0

metaversion

string

Public API version that served the response.

one of: v1

Headers

Code example

Responses