Skip to content

Get Server

GET
/api/v1/servers/{id}

Gets a server. May return 404 if the server is private and you are unauthorized.

id
required
string format: int64

The ID of the server.

The server.

object
id
string format: int64
name
string
nullable
icon
string
nullable
commandsWhitelist
boolean
xpWhitelist
boolean
commandsChannels
Array<string>
nullable
xpChannels
Array<string>
nullable
messageXp
integer format: int32
levelFormula
string
nullable
levelMessageEnabled
boolean
nullable
levelMessage
string
nullable
levelMessageLocation
string format: int64
nullable
voiceXp
integer format: int32
deleteOnLeave
boolean
nullable
economy
boolean
currencySymbol
string
nullable
levelCurrency
integer format: int32
startingCurrency
integer format: int32
currencyTransfer
boolean
nullable
public
boolean
nullable
crateError
boolean
nullable
shop
boolean
shopLogChannel
string format: int64
nullable
aboutText
string
nullable
currencyTransferMin
integer format: int32
currencyTransferPing
boolean
nullable
economyGames
boolean
nullable
crates
Array<object>
nullable
object
id
integer format: int32
serverId
string format: int64
name
string
nullable
criteria
integer format: int32
criteriaCount
integer format: int32
channels
Array<string>
nullable
xp
integer format: int32
duration
integer format: int32
criteriaProgress
integer format: int32
dropTime
string format: date-time
announcementChannel
string format: int64
nullable
announcementMessage
string
nullable
color
integer format: int32
maxRedeemers
integer format: int32
pingHere
boolean
redeemers
Array<string>
nullable
cooldown
integer format: int32
imageUrl
string
nullable
reaction
boolean
currency
integer format: int32
dropMessage
string format: int64
nullable
dropNow
boolean
showRedeems
boolean
pingRoles
Array<string>
nullable
server
object recursive
roles
Array<object>
nullable
object
id
string format: int64
serverId
string format: int64
level
integer format: int32
xpMultiplier
number format: float
levelMessage
string
nullable
stack
boolean
stackGroup
string
nullable
dependencies
Array<string>
nullable
shops
Array<object>
nullable
object
serverId
string format: int64
id
string format: uuid
name
string
nullable
price
integer format: int32
description
string
nullable
reward
string
nullable

If you do not have access to this server.

If the server does not exist or is private, and you are not authorized.