Skip to content
GAMPEONCreate
New project

A community

GET
/v1/communities/{id}
curl --request GET \
--url https://api.gampeon.com/v1/communities/1

Without membership only a preview of open communities. Members also get me (their permissions in the community, roles, timeout), the channels they can see with their permissions and unread state, and all roles. permissions are bitmasks, see BITMASK in the role schema.

Not available with access tokens.

id
required
integer
>= 1

Community ID

Community

Media typeapplication/json
object
id
required
integer
name
required
string
description
required
string
icon
required
One of:

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

string
cover
required
One of:

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

string
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
member
required
boolean
banned
required
boolean
hidden
required
One of:
object
at
required

Unix time in milliseconds

integer format: int64
reason
required
string
servers
required

Online servers, most players first (up to 10)

Array<object>
object
id
required
string
name
required
string
players
required
integer
maxPlayers
required
integer
project
required
object
slug
required
string
title
required
string
me
object
permissions
required

Bitmask of permissions, see the table in the Communities section

integer
admin
required
boolean
owner
required
boolean
team
required
boolean
roles
required
Array<integer>
timeoutUntil
required
One of:

Unix time in milliseconds

integer format: int64
top
required
One of:

Your highest role position, null for managers

integer
channels
Array<object>
object
id
required
integer
kind
required
string
Allowed values: category text announcement voice
name
required
string
topic
required
string
parentId
required
One of:

Category

integer
position
required
integer
slowmode
required

Seconds between two messages of the same person. 0 is off

integer
permissions
required

Your effective permissions in this channel (see permissions on the community)

integer
lastMessageId
required
integer
unread
required
boolean
mentions
required

Unread messages that mention you

integer
userLimit

Only voice channels: most people at once, 0 is no limit of the community

integer
overrides

Only with manageChannels

Array<object>
object
roleId
required
integer
allow
required

Bits allowed in this channel

integer
deny
required

Bits denied in this channel

integer
roles
Array<object>
object
id
required
integer
name
required
string
color
required
One of:
string
/^#[0-9a-fA-F]{6}$/
position
required

Higher is more powerful. everyone is always 0

integer
permissions
required

Bitmask of permissions, see the table in the Communities section

integer
hoist
required

Shown as its own group in the member list

boolean
everyone
required

The default role every member has

boolean
members
required
integer

Example

{
"owner": {
"type": "studio"
},
"joinMode": "open",
"channels": [
{
"kind": "category"
}
]
}

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

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