Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"config": {
"name": "<string>",
"slogan": "<string>",
"description": "<string>",
"websiteUrl": "<string>",
"apiUrl": "<string>",
"version": "<string>",
"location": "GLOBAL",
"game": {
"type": "<string>",
"name": "<string>",
"serverIP": "<string>",
"serverVersion": "<string>"
},
"logo": "<string>",
"favicon": "<string>",
"loginProvider": "<string>",
"maintenance": true,
"captcha": {
"enabled": true,
"provider": "turnstile",
"siteKey": "<string>",
"pages": {}
},
"branding": {
"canRemove": true,
"url": "<string>"
},
"settings": {},
"modules": {},
"theme": {
"id": "<string>",
"active": true,
"settings": {}
}
},
"locale": "<string>",
"languages": [
{
"code": "<string>",
"name": "<string>"
}
],
"currency": {
"code": "<string>",
"symbol": "<string>",
"label": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"rate": 123,
"isDefault": true
},
"currencies": [
{
"code": "<string>",
"symbol": "<string>",
"label": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"rate": 123,
"isDefault": true
}
],
"header": [
{
"title": "<string>",
"url": "<string>",
"id": "<string>",
"icon": "<string>",
"tab": 123,
"route": "<string>",
"module": "<string>",
"children": "<array>"
}
],
"footer": [
{
"title": "<string>",
"url": "<string>",
"id": "<string>",
"icon": "<string>",
"tab": 123,
"route": "<string>",
"module": "<string>",
"children": "<array>"
}
],
"roles": [
{
"id": 123,
"name": "<string>",
"slug": "<string>",
"usernameCSS": "<string>",
"badgeCSS": "<string>"
}
],
"announcements": [
{
"id": 123,
"title": "<string>",
"url": "<string>"
}
],
"onlineCount": 123,
"showDiscordSyncButton": true,
"cartItemCount": 123,
"user": {
"id": 123,
"username": "<string>",
"displayName": "<string>",
"email": "<string>",
"credits": 123,
"avatar": "<string>",
"isEmailVerified": true,
"isStaff": true,
"isTfaRequired": true,
"discordUserID": "<string>",
"roles": [
{
"id": 123,
"name": "<string>",
"slug": "<string>",
"usernameCSS": "<string>",
"badgeCSS": "<string>"
}
],
"permissions": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"creditsFormatted": "<string>"
}
},
"message": "<string>"
}{
"success": false,
"error": {
"code": "UNAUTHENTICATED",
"message": "..."
}
}{
"success": false,
"error": {
"code": "LICENSE_INVALID",
"message": "..."
}
}Site
Layout bootstrap
Everything a layout needs in one call: config, navigation (header/footer), languages, currencies, roles, announcements, online count, cart item count and the current user (if a Bearer token is sent).
GET
/
site
/
bootstrap
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"config": {
"name": "<string>",
"slogan": "<string>",
"description": "<string>",
"websiteUrl": "<string>",
"apiUrl": "<string>",
"version": "<string>",
"location": "GLOBAL",
"game": {
"type": "<string>",
"name": "<string>",
"serverIP": "<string>",
"serverVersion": "<string>"
},
"logo": "<string>",
"favicon": "<string>",
"loginProvider": "<string>",
"maintenance": true,
"captcha": {
"enabled": true,
"provider": "turnstile",
"siteKey": "<string>",
"pages": {}
},
"branding": {
"canRemove": true,
"url": "<string>"
},
"settings": {},
"modules": {},
"theme": {
"id": "<string>",
"active": true,
"settings": {}
}
},
"locale": "<string>",
"languages": [
{
"code": "<string>",
"name": "<string>"
}
],
"currency": {
"code": "<string>",
"symbol": "<string>",
"label": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"rate": 123,
"isDefault": true
},
"currencies": [
{
"code": "<string>",
"symbol": "<string>",
"label": "<string>",
"prefix": "<string>",
"suffix": "<string>",
"rate": 123,
"isDefault": true
}
],
"header": [
{
"title": "<string>",
"url": "<string>",
"id": "<string>",
"icon": "<string>",
"tab": 123,
"route": "<string>",
"module": "<string>",
"children": "<array>"
}
],
"footer": [
{
"title": "<string>",
"url": "<string>",
"id": "<string>",
"icon": "<string>",
"tab": 123,
"route": "<string>",
"module": "<string>",
"children": "<array>"
}
],
"roles": [
{
"id": 123,
"name": "<string>",
"slug": "<string>",
"usernameCSS": "<string>",
"badgeCSS": "<string>"
}
],
"announcements": [
{
"id": 123,
"title": "<string>",
"url": "<string>"
}
],
"onlineCount": 123,
"showDiscordSyncButton": true,
"cartItemCount": 123,
"user": {
"id": 123,
"username": "<string>",
"displayName": "<string>",
"email": "<string>",
"credits": 123,
"avatar": "<string>",
"isEmailVerified": true,
"isStaff": true,
"isTfaRequired": true,
"discordUserID": "<string>",
"roles": [
{
"id": 123,
"name": "<string>",
"slug": "<string>",
"usernameCSS": "<string>",
"badgeCSS": "<string>"
}
],
"permissions": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"creditsFormatted": "<string>"
}
},
"message": "<string>"
}{
"success": false,
"error": {
"code": "UNAUTHENTICATED",
"message": "..."
}
}{
"success": false,
"error": {
"code": "LICENSE_INVALID",
"message": "..."
}
}Authorizations
publicKeypublicKey & bearerAuth
