Get a Discord guild template by code: its name, usage count, creator id and serialized channel and role layout.
GET /v1/discord/templates/{code}
x-api-key* string header
API key (`sfk_...`)
code* string required path
Guild template code, 1 to 64 letters, digits, underscores or hyphens.
min 1 chars · max 64 chars · pattern: ^[A-Za-z0-9_-]+$
Response fields 56 Expand all Collapse all Collapse all Endpoint-specific response payload.
`not_found` when no template has the code.
one of: found, not_found, restricted
The template when found; otherwise null.
data . template . description
string nullable
Template description.
data . template . usageCount
integer nullable
How many times it was used.
data . template . creatorId
string nullable
Template creator id.
data . template . createdAt
string nullable
When it was created.
data . template . updatedAt
string nullable
When it was updated.
data . template . isDirty
boolean nullable
The template's dirty flag, when present.
data . template . sourceServerId
string nullable
The server it was made from.
data . template . serializedSourceServer object nullable
The template's serialized server layout.
data . template . serializedSourceServer . name
string nullable
Server name.
data . template . serializedSourceServer . description
string nullable
Server description.
data . template . serializedSourceServer . region
string nullable
Server region.
data . template . serializedSourceServer . verificationLevel
integer nullable
Verification level.
data . template . serializedSourceServer . defaultMessageNotifications
integer nullable
Default notification setting.
data . template . serializedSourceServer . explicitContentFilter
integer nullable
Explicit content filter.
data . template . serializedSourceServer . preferredLocale
string nullable
Preferred locale.
data . template . serializedSourceServer . afkChannelId
integer nullable
AFK channel id.
data . template . serializedSourceServer . afkTimeout
integer nullable
AFK timeout.
data . template . serializedSourceServer . systemChannelId
integer nullable
System channel id.
data . template . serializedSourceServer . systemChannelFlags
integer nullable
System channel flags.
data . template . serializedSourceServer . roles array
Roles.
data . template . serializedSourceServer . roles [] . id
integer nullable
Role id in the template.
data . template . serializedSourceServer . roles [] . name
string nullable
Role name.
data . template . serializedSourceServer . roles [] . permissions
string nullable
Permission bitfield.
data . template . serializedSourceServer . roles [] . color
integer nullable
Role colour.
data . template . serializedSourceServer . roles [] . colors
object nullable
Role colours by gradient stop, passed through.
data . template . serializedSourceServer . roles [] . hoist
boolean nullable
Whether the role is hoisted.
data . template . serializedSourceServer . roles [] . mentionable
boolean nullable
Whether it is mentionable.
data . template . serializedSourceServer . roles [] . icon
string nullable
Role icon hash.
data . template . serializedSourceServer . roles [] . unicodeEmoji
string nullable
Role unicode emoji.
data . template . serializedSourceServer . channels array
Channels.
data . template . serializedSourceServer . channels [] . id
integer nullable
Channel id in the template.
data . template . serializedSourceServer . channels [] . type
integer nullable
Channel type.
data . template . serializedSourceServer . channels [] . name
string nullable
Channel name.
data . template . serializedSourceServer . channels [] . position
integer nullable
Channel position.
data . template . serializedSourceServer . channels [] . topic
string nullable
Channel topic.
data . template . serializedSourceServer . channels [] . nsfw
boolean nullable
Whether the channel is NSFW.
data . template . serializedSourceServer . channels [] . parentId
integer nullable
Parent category id.
data . template . serializedSourceServer . channels [] . bitrate
integer nullable
Voice bitrate.
data . template . serializedSourceServer . channels [] . userLimit
integer nullable
Voice user limit.
data . template . serializedSourceServer . channels [] . rateLimitPerUser
integer nullable
Slowmode seconds.
data . template . serializedSourceServer . channels [] . permissionOverwrites array
Permission overwrites, passed through.
data . template . serializedSourceServer . channels [] . permissionOverwrites []
object optional
data . template . serializedSourceServer . channels [] . availableTags array
Forum tags, passed through.
data . template . serializedSourceServer . channels [] . availableTags []
object optional
data . template . serializedSourceServer . channels [] . defaultAutoArchiveDuration
integer nullable
Default thread auto-archive duration.
data . template . serializedSourceServer . channels [] . iconEmoji
object nullable
Channel icon emoji, passed through.
data . template . serializedSourceServer . channels [] . themeColor
integer nullable
Channel theme colour.
Metadata describing the request and billing outcome.
Unique request identifier for tracing this API call.
meta . creditsCharged
integer
Credits charged for this request.
Public API version that served the response.