Preview an invite

GET

/v1/community-invites/{code}

curl --request GET \
  --url https://api.gampeon.com/v1/community-invites/example

• Production

Name, icon, members and rules of the community behind an invite link.

Rate limit: 60 per hour per IP.

Parameters

Path Parameters

code

required

string

/^[A-Za-z0-9]{8}$/

Invite code

Responses

200

Invite

Media typeapplication/json

object

code

required

string

expiresAt

required

Unix time in milliseconds

integer format: int64

community

required

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

rules

required

string

Example

{
  "community": {
    "owner": {
      "type": "studio"
    },
    "joinMode": "open"
  }
}

404

Error codes: invite_invalid

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"
}

429

Limit: 60 per hour per IP. Error codes: rate_limited

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"
}