Discover communities

GET

/v1/communities

curl --request GET \
  --url https://api.gampeon.com/v1/communities

• Production

Open communities of published studios and projects, most members first (up to 50). Accounts under 16 do not see communities for 16+. With login, joined says whether you are a member.

Not available with access tokens.

Authorizations

• None
• session

Parameters

Query Parameters

q

string

<= 64 characters

Search in name and description

Responses

200

Communities

Media typeapplication/json

object

communities

required

Array

object

id

required

integer

name

required

string

description

required

string

icon

required

One of:

string

Image path under /v1/media/ (studio logo or project key art)

string

null

null

cover

required

One of:

string

Banner image under /v1/media/: the cover of the studio or the project. null if there is none

string

null

null

owner

required

object

type

required

string

Allowed values: studio project

slug

required

string

/^[a-z0-9][a-z0-9-]{1,30}[a-z0-9]$/

name

required

string

joinMode

required

open: anyone who meets the minimum age can join. invite: only with an invite link

string

Allowed values: open invite

minAge

required

13 or 16. Communities for 18+ come only with real age verification

integer

members

required

integer

players

required

Players online right now on servers of the project (or of all projects of the studio)

integer

createdAt

required

Unix time in milliseconds

integer format: int64

joined

required

boolean

Example

{
  "communities": [
    {
      "owner": {
        "type": "studio"
      },
      "joinMode": "open"
    }
  ]
}

403

Error codes: 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"
}