Skip to main content

List players

Get a paginated list of players for the current domain.

Query Parameters
per_page integer

Possible values: 1 ≤ value ≤ 100

Number of results per page

page integer

Possible values: 1 ≤ value

Page number

Responses
200

successful operation

Schema OPTIONAL
data object[] OPTIONAL
uuid uuid OPTIONAL

Unique identifier for the player

username string OPTIONAL

Player's display name

service_users object[] OPTIONAL

Connected service accounts (Steam, Discord, etc.)

uuid uuid OPTIONAL

Unique identifier for the player's service user

service_id string OPTIONAL

External ID from the service provider (Steam ID, Discord ID, etc.)

username string OPTIONAL

Username from the service provider

type string OPTIONAL

Possible values: [steam, mojang, epic, eos, discord, twitch, patreon, microsoft, google]

Service type identifier. Mapping to numeric IDs: steam=0, mojang=1, epic=2, eos=3, discord=4, twitch=5, patreon=6, microsoft=7, google=8

custom_roles object[] OPTIONAL

Custom roles assigned to the player

id integer OPTIONAL

Role ID

name string OPTIONAL

Role name

expires_at date-time OPTIONAL

When this role assignment expires

characters integer OPTIONAL

Number of characters associated with this player

activity object OPTIONAL

Player activity information

status boolean OPTIONAL

Whether the player is currently online

last_online_at date-time OPTIONAL

When the player was last online

stats object OPTIONAL

Player statistics

votes integer OPTIONAL

Number of votes cast by the player

donated_amount float OPTIONAL

Total amount donated by the player

token_balance integer OPTIONAL

Current token balance

moderation object OPTIONAL

Moderation status information

rules object OPTIONAL

Rules acceptance status

accepted boolean OPTIONAL

Whether the player has accepted the rules

accepted_at date-time OPTIONAL

When the player accepted the rules

banned object OPTIONAL

Ban status

is_banned boolean OPTIONAL

Whether the player is currently banned

until date-time OPTIONAL

When the ban expires (null if permanent or not banned)

muted object OPTIONAL

Mute status

is_muted boolean OPTIONAL

Whether the player is currently muted

until date-time OPTIONAL

When the mute expires (null if permanent or not muted)

email object OPTIONAL

Email verification status

setup boolean OPTIONAL

Whether the player has set up an email address

confirmed boolean OPTIONAL

Whether the player's email address is confirmed

created_at date-time OPTIONAL

Date and time when the player account was created

links object OPTIONAL
first string OPTIONAL
last string OPTIONAL
prev string OPTIONAL
next string OPTIONAL
meta object OPTIONAL
current_page integer OPTIONAL
from integer OPTIONAL
last_page integer OPTIONAL
links object[] OPTIONAL
url string OPTIONAL
label string OPTIONAL
active boolean OPTIONAL
path string OPTIONAL
per_page integer OPTIONAL
to integer OPTIONAL
total integer OPTIONAL