Skip to content
GAMPEONCreate
GAMPEON on Discord
New project

Project page

GET
/v1/projects/{slug}
curl --request GET \
  --url https://api.gampeon.com/v1/projects/example

Gallery, links, linked servers, marketplace items and team. For studio projects, owner also has members and projects (published). viewer tells whether you may edit the project or link your servers and items to it, and whether it is one of your favorites. The team also gets the checklist for publishing. Drafts and hidden projects: only the team and moderation.

Access tokens: scope projects:read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string
/^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$/

Project slug

Responses

Section titled “Responses”

200

Section titled “200”

Project

Media typeapplication/json
object
slug
required
string
/^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$/
title
required
string
tagline
required
string
genre
required
string
Allowed values: roleplay racing shooter survival parkour sandbox minigames simulation other
tags
required
Array<string>
status
required

Development stage, in this order: concept, development, alpha, beta, released

string
Allowed values: concept development alpha beta released
languages
required

Languages of the game (ISO 639-1), up to 10

Array<string>
Allowed values: en de fr es it pt nl pl cs sk hu ro bg el tr ru uk sv da no fi ar he hi th vi id ja ko zh
cover
required
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
owner
required
One of:
object
type
required
Allowed value: studio
slug
required
string
name
required
string
logo
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
players
required

Players on linked servers that are online

integer
online
required

Linked servers that are online

integer
items
required

Linked marketplace items with at least one free version

integer
favorites
required

Accounts that marked the project as a favorite

integer
views
required

Page views (counted once per visitor and day, the team not included)

integer
createdAt
required

Unix time in milliseconds

integer format: int64
updatedAt
required

Unix time in milliseconds

integer format: int64
releasedAt
required
One of:

First time the status was set to released

integer format: int64
publishedAt
required
One of:

When the project was published. null: draft, only the team sees it

integer format: int64
description
required

Markdown: headings, lists, quotes, bold, italic, links

string
website
required
One of:
string
links
required

Links besides the website: Discord invite, YouTube channel, X, Twitch, TikTok profile, Steam store page. Only https://. In a change, an empty string removes a link.

object
discord
string
youtube
string
x
string
twitch
string
tiktok
string
steam
string
gallery
required

Screenshots and videos in order

Array
One of:
object
id
required
string
type
required
Allowed value: image
url
required
One of:

Image path (/v1/media/…). null only for the team when moderation removed the image

string
width
required
integer
height
required
integer
caption
required
string
removed

Only for the team: removed by moderation

boolean
peakPlayers
required
integer
servers
required
Array<object>
object
id
required

Server ID

string format: uuid
name
required
string
description
required
string
website
required
One of:
string
owner
required
object
handle
required

Unique handle

string
/^[a-z0-9_]{3,24}$/
displayName
required
string
avatar
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
online
required

Sent a heartbeat in the last 90 seconds

boolean
address
required
One of:

Host name or IP address players connect to

string
port
required
One of:
integer
players
required
integer
maxPlayers
required
integer
tags
required
Array<string>
language
required
One of:

Language code such as en or de-DE

string
lastSeen
required

Last heartbeat (Unix time in milliseconds)

integer format: int64
peakPlayers
required

Highest player count reported over two consecutive heartbeats

integer
project
required
One of:
object
slug
required
string
title
required
string
resources
required
Array<object>
object
name
required

Unique resource name

string
/^[a-z0-9][a-z0-9_\-]{1,47}$/
title
required
string
description
required
string
kind
required
string
Allowed values: script vehicle map prop clothing gamemode tool
tags
required
Array<string>
owner
required
object
handle
required

Unique handle

string
/^[a-z0-9_]{3,24}$/
displayName
required
string
avatar
One of:

Image path relative to the API (/v1/media/…). null without an image.

string
latestVersion
required
One of:

Newest version that is not blocked

string
image
required
One of:

Path of the preview image, relative to the API, for example /v1/images/<sha256>.webp

string
downloads
required

Downloads of all versions

integer
price
required

Price in GAMPEONS, 0 = free

integer
createdAt
required

Unix time in milliseconds

integer format: int64
updatedAt
required

Unix time in milliseconds

integer format: int64
team
required
Array<object>
object
handle
required
string
displayName
required
string
avatar
required
One of:

Image path (/v1/media/…)

string
role
required
string
viewer
required
object
canEdit
required
boolean
canLink
required
boolean
favorited
required
boolean
community
required
One of:

Community for the button on the game page: the project’s own, otherwise the studio’s. Only when you can see it (open, member or team).

object
id
required
integer
name
required
string
scope
required

Community of the project itself, or of its studio

string
Allowed values: project studio
joinMode
required
string
Allowed values: open invite
member
required

You are a member

boolean
checklist

Only for the team

Array<object>
object
id
required
string
Allowed values: tagline description cover gallery tags languages links
done
required
boolean
required
required

Needed to publish. Required: a tagline and an about text with at least 100 characters

boolean
hidden
object
at
required

When moderation hid the page

integer format: int64
reason
required
One of:

Statement of reasons (DSA Art. 17)

string

Example 

{
  "genre": "roleplay",
  "status": "concept",
  "languages": [
    "en"
  ],
  "owner": {
    "type": "studio"
  },
  "gallery": [
    {
      "type": "image"
    }
  ],
  "resources": [
    {
      "kind": "script"
    }
  ],
  "community": {
    "scope": "project",
    "joinMode": "open"
  },
  "checklist": [
    {
      "id": "tagline"
    }
  ]
}

403

Section titled “403”

Error codes: insufficient_scope, token_not_allowed

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
  "error": "example",
  "message": "example"
}

404

Section titled “404”

Error codes: not_found

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
  "error": "example",
  "message": "example"
}

Report a problem with this pageOther ways to give feedback