Skip to content
RallyHere Docs

Admin Get Player Presence

GET
/presence/v1/admin/player/uuid/{player_uuid}/presence

Get the player’s presence information. The status reflects the true value and is not modified before it is returned.

Authorizations

Parameters

Path Parameters

player_uuid
required

A valid UUID identifying a player. Rejects integer player identification.

string format: uuid

A valid UUID identifying a player. Rejects integer player identification.

Query Parameters

use_cache
boolean
default: true

Responses

200

Successful Response

object
status

Is the player currently online?

string
Allowed values: online away invisible offline
message

Optional custom message to display alongside the user’s online status

string
"" <= 256 characters
platform
required

Platform the user was online in

string
display_name
required

Player Display Name

string
custom_data

Custom fields for the player to update about their presence

object
key
additional properties
string
>= 1 characters <= 4096 characters
player_id

Player ID for the player if it was provided as part of the request

integer
player_uuid
required

UUID of the player whose presence this represents

string format: uuid
do_not_disturb

Disables notifications and invites. Only set for self or admin.

boolean
last_seen

Info about the player the last time they reported their status. Only set for self or admin

string format: date-time

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Not Found

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string