Skip to content
RallyHere Docs

Get Player Linked Portals

Deprecated
GET
/users/v1/player/{player_id}/linked_portals

DEPRECATED Please use /v2/player/{player_uuid}/links instead. Get a player’s linked portals.

Authorizations

Parameters

Path Parameters

player_id
required
integer

Responses

200

Successful Response

Response for getting a player’s linked portals

object
player
required

Player info

object
player_id
required

Player ID DEPRECATED use player_uuid instead

integer
player_uuid
required

Player UUID

string format: uuid
active_player_id

DEPRECATED use active_player_uuid instead. Active player ID, if the player has an active player.

integer
active_player_uuid

Active player UUID, if the player has an active player.

string format: uuid
person_id
required

Person ID

string format: uuid
role_id

Role ID of the person, if available

string
linked_portals
required

List of linked portals

Array<object>
object
portal_user_id

Portal user ID

string
portal_id
required

Portal ID DEPRECATED use platform instead

integer
platform
required

Platform

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch RallyHere LegacyName
display_name

Display name

string
player_id
required

Player ID DEPRECATED use player_uuid instead

integer
player_uuid
required

Player UUID

string format: uuid

403

Error Codes:

  • auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token
  • auth_invalid_version - Invalid Authorization - version
  • auth_malformed_access - Invalid Authorization - malformed access token
  • auth_not_jwt - Invalid Authorization
  • auth_token_expired - Token is expired
  • auth_token_format - Invalid Authorization - {}
  • auth_token_invalid_claim - Token contained invalid claim value: {}
  • auth_token_sig_invalid - Token Signature is invalid
  • auth_token_unknown - Failed to parse token
  • insufficient_permissions - Insufficient Permissions
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