Skip to main content
POST
/
activity
/
playerJoin
Player joins a game session
curl --request POST \
  --url https://api.readmin.app/activity/playerJoin \
  --header 'Content-Type: application/json' \
  --header 'loader-id: <api-key>' \
  --data '
{
  "playerId": 123,
  "platform": "Phone",
  "safechat": true,
  "username": "<string>",
  "tzOffset": "<string>"
}
'
{
  "success": true,
  "banned": true,
  "reason": "<string>",
  "isStaff": true,
  "sessionId": "<string>",
  "runningPlayerId": "<string>"
}

Authorizations

​
loader-id
string
header
required

Body

application/json
​
playerId
number
required

Unique identifier for the player

​
platform
enum<string>
required

The platform from which the player is accessing the game.

Available options:
Phone,
Tablet,
Console,
Desktop,
unknown
​
safechat
boolean
required

Indicates if the player has safe chat enabled

​
username
string

Player's username

​
tzOffset
string

Timezone offset from UTC, in ISO 8601 format

Response

Player joined successfully

​
success
boolean
​
banned
boolean
​
reason
string | null
​
isStaff
boolean
​
sessionId
string
​
runningPlayerId
string