Server Templates
These API endpoints are related to user-submitted Discord server template listings
Gets all server templates on the list, paginated, optionally filtered by tag
page?stringThe page number
owner?stringFilter to templates submitted by this user ID. Omit to return every submitter's.
Success
application/json- response
count?integer0 <= value <= 18446744073709552000per_page?integer0 <= value <= 18446744073709552000results?array<>curl -X GET 'https://spider.omniplex.gg/server-templates/@all'{ "count": 0, "per_page": 0, "results": [ { "channel_count": 0, "channels": [ { "id": 0, "name": "string", "parent_id": 0, "position": 0, "type": 0 } ], "code": "string", "created_at": "2019-08-24T14:15:22Z", "dislikes": 0, "icon_version": "string", "id": "string", "likes": 0, "name": "string", "nsfw": true, "out_of_date": true, "owner": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "role_count": 0, "roles": [ { "color": 0, "id": 0, "name": "string" } ], "short": "string", "source_updated_at": "2019-08-24T14:15:22Z", "synced_at": "2019-08-24T14:15:22Z", "tags": [ "string" ], "unavailable": true, "updated_at": "2019-08-24T14:15:22Z", "usage_count": 0 } ]}Gets a single server template by its internal ID
id*stringThe template's internal ID
Success
application/json- response
channel_count?integerHow many channels (not counting categories) the template has
channels?array<>A preview of the template's channels, captured from Discord at submission time. Empty on list responses -- only the single-template fetch populates this
code?stringThe Discord server template code
created_at?stringdate-timedislikes?integerHow many people disliked the template
icon_version?stringThe version of the template's custom icon, used to build its CDN URL. Null when it has none
id?stringlikes?integerHow many people liked the template
name?stringThe template's name, pulled from Discord at submission time
nsfw?booleanWhether the template is for an NSFW-oriented server
out_of_date?booleanWhether the source server has changes that haven't been synced into the template on Discord yet
owner?The user who submitted the template
role_count?integerHow many roles (not counting @everyone) the template has
roles?array<>A preview of the template's roles (excluding @everyone), captured from Discord at submission time. Empty on list responses -- only the single-template fetch populates this
short?stringThe submitter's description of the template
source_updated_at?stringWhen the template was last updated on Discord
date-timesynced_at?stringWhen Omniplex last refreshed the template from Discord
date-timetags?array<>The template's tags
unavailable?booleanWhether the template no longer exists on Discord. Unavailable templates are hidden from browse
updated_at?stringdate-timeusage_count?integerDiscord's own reported usage count, as of the last sync
curl -X GET 'https://spider.omniplex.gg/server-templates/string'{ "channel_count": 0, "channels": [ { "id": 0, "name": "string", "parent_id": 0, "position": 0, "type": 0 } ], "code": "string", "created_at": "2019-08-24T14:15:22Z", "dislikes": 0, "icon_version": "string", "id": "string", "likes": 0, "name": "string", "nsfw": true, "out_of_date": true, "owner": { "avatar": "string", "bot": true, "display_name": "string", "extra_data": { "property1": null, "property2": null }, "flags": [ "string" ], "id": "string", "status": "string", "username": "string" }, "role_count": 0, "roles": [ { "color": 0, "id": 0, "name": "string" } ], "short": "string", "source_updated_at": "2019-08-24T14:15:22Z", "synced_at": "2019-08-24T14:15:22Z", "tags": [ "string" ], "unavailable": true, "updated_at": "2019-08-24T14:15:22Z", "usage_count": 0}Submits a Discord server template listing. The template's name is pulled from Discord's own public template metadata at submission time -- Discord validates the code, not Popplio.
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
id*stringThe user's ID
application/json- body
code?stringnsfw?booleanshort?stringtags?array<string>Success
application/json- response
id?stringThe created template's internal ID
curl -X PUT 'https://spider.omniplex.gg/users/string/server-templates' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string"}Updates a server template's description, tags, and NSFW flag. You must be the owner. Returns 204 on success
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
uid*stringThe user's ID
id*stringThe template's internal ID
application/json- body
nsfw?booleanshort?stringtags?array<string>Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X PATCH 'https://spider.omniplex.gg/users/string/server-templates/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Deletes a server template. You must be the owner to delete it. Returns 204 on success
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
uid*stringThe user's ID
id*stringThe template's internal ID
Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X DELETE 'https://spider.omniplex.gg/users/string/server-templates/string'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Refreshes a server template's name, usage count, channels and roles from Discord. You must be the owner. Returns 204 on success, or 409 if the template no longer exists on Discord (it's then hidden from browse until it's back)
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
uid*stringThe user's ID
id*stringThe template's internal ID
Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X POST 'https://spider.omniplex.gg/users/string/server-templates/string/sync'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Sets or removes a server template's custom icon. The icon itself is uploaded through the website first. You must be the owner. Returns 204 on success
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
uid*stringThe user's ID
id*stringThe template's internal ID
application/json- body
version?stringThe uploaded icon's version, or null to remove the icon
Success
application/json- response
context?Context of the error. Usually used for validation error contexts
message?stringMessage of the error
curl -X PUT 'https://spider.omniplex.gg/users/string/server-templates/string/icon' \ -H 'Content-Type: application/json' \ -d '{}'{ "context": { "property1": "string", "property2": "string" }, "message": "string"}Gets a server template's like/dislike counts, plus the given user's own reaction if any. No session required -- reactions aren't private.
uid*stringThe user's ID
id*stringThe template's internal ID
Success
application/json- response
dislikes?integerlikes?integeruser_liked?booleanThe requesting user's own reaction: true if liked, false if disliked, null if they haven't reacted
curl -X GET 'https://spider.omniplex.gg/users/string/server-templates/string/reaction'{ "dislikes": 0, "likes": 0, "user_liked": true}Sets, switches, or clears the caller's like/dislike on a server template. Sending the same reaction that's already active clears it. Returns the updated counts. Returns 204 on success
UserUser-Auth<token>Requires a user token. Should be prefixed with User in Authorization header.
uid*stringThe user's ID
id*stringThe template's internal ID
liked*stringWhether to like (true) or dislike (false) the template. Must be either true or false
Success
application/json- response
dislikes?integerlikes?integeruser_liked?booleanThe requesting user's own reaction: true if liked, false if disliked, null if they haven't reacted
curl -X PUT 'https://spider.omniplex.gg/users/string/server-templates/string/reaction?liked=string'{ "dislikes": 0, "likes": 0, "user_liked": true}