Skip to content
GAMPEONCreate
GAMPEON on Discord
New project

Studio page

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

Members, projects and your role (viewerRole). Owners and admins also see open invites.

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]$/

Studio slug

Responses

Section titled “Responses”

200

Section titled “200”

Studio

Media typeapplication/json
object
slug
required
string
/^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$/
name
required
string
tagline
required
string
logo
required
One of:

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

string
cover
required
One of:

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

string
members
required

Number of members

integer
projects
required

Number of visible projects

integer
players
required

Players on online servers of all projects

integer
createdAt
required

Unix time in milliseconds

integer format: int64
description
required
string
website
required
One of:
string
updatedAt
required

Unix time in milliseconds

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

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

string
role
required
string
Allowed values: owner admin member
joinedAt
required

Unix time in milliseconds

integer format: int64
memberCount
required
integer
projects
required
Array<object>
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
projectCount
required
integer
viewerRole
required
One of:
string
Allowed values: owner admin member
invites

Only for owners and admins

Array<object>
object
id
required
string format: uuid
handle
required
string
displayName
required
string
role
required
string
Allowed values: admin member
createdAt
required

Unix time in milliseconds

integer format: int64
expiresAt
required

Unix time in milliseconds

integer format: int64
hidden
object
at
required

When moderation hid the page

integer format: int64
reason
required
One of:

Statement of reasons (DSA Art. 17)

string

Example 

{
  "members": [
    {
      "role": "owner"
    }
  ],
  "projects": [
    {
      "genre": "roleplay",
      "status": "concept",
      "languages": [
        "en"
      ],
      "owner": {
        "type": "studio"
      }
    }
  ],
  "viewerRole": "owner",
  "invites": [
    {
      "role": "admin"
    }
  ]
}

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