Skip to main content
GET
/
v0
/
players
List players
curl --request GET \
  --url https://controller.platform.simplecloud.app/v0/players \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>'
{
  "count": 25,
  "players": [
    {
      "connected_proxy_name": "proxy-1",
      "connected_server_name": "lobby-1",
      "display_name": "Steve",
      "first_seen": "2023-01-01T12:00:00Z",
      "id": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
      "last_seen": "2023-06-15T18:30:00Z",
      "name": "Steve",
      "online": true,
      "online_time_seconds": 36000,
      "properties": {},
      "session_id": "sess_abc123"
    }
  ],
  "total": 1000
}

Headers

X-Network-ID
string
required

Network ID

X-Network-Secret
string
required

Network Secret

Query Parameters

online
boolean

Filter by online status

server
string

Filter by connected server

Search by name

sort_by
string

Sort by field (name, last_login, online_time, first_login)

sort_order
string

Sort order (asc, desc)

limit
integer

Limit results (default 50)

offset
integer

Offset for pagination

Response

OK

Response for listing players

count
integer
Example:

25

players
object[]
total
integer
Example:

1000