Skip to main content
GET
List players

Headers

X-Network-ID
string
required

Network ID

X-Network-Credential
string
required

Network Credential (network password or JWT)

Query Parameters

online
boolean

Filter by online status

server
string

Filter by exact connected server name; implies online=true

proxy
string

Filter by exact connected proxy name; implies online=true

player_id
string[]

Filter by player UUID; repeat the parameter or use comma-separated values

first_seen_from
string<date-time>

Include players first seen at or after this RFC3339 timestamp

first_seen_to
string<date-time>

Include players first seen at or before this RFC3339 timestamp

last_seen_from
string<date-time>

Include players last seen at or after this RFC3339 timestamp

last_seen_to
string<date-time>

Include players last seen at or before this RFC3339 timestamp

online_time_seconds_min
integer

Minimum accumulated online time in seconds

Required range: x >= 0
online_time_seconds_max
integer

Maximum accumulated online time in seconds

Required range: x >= 0

Case-insensitive literal substring search against the current name

sort_by
enum<string>
default:last_seen

Sort field

Available options:
name,
last_seen,
last_login,
online_time_seconds,
online_time,
first_seen,
first_login
sort_order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
limit
integer

Limit results (default 50, maximum 1000)

offset
integer
default:0

Offset for pagination

Response

OK

Response for listing players

count
integer
Example:

25

players
object[]
total
integer
Example:

1000