Skip to content

Lookup Player By Portal

GET
/users/v1/player

Lookup players by various parameters. Note that this does NOT find the active player, or other metadata about the resulting players. It is suggested to call /v1/player/{player_id}/linked_portals for each player for that info, if necessary.

Authorizations

Parameters

Query Parameters

display_name

Lookup players by display names

Array<string>
default:

Lookup players by display names

identity_platform
deprecated

Lookup players by their portal identity for this platform

integer

Lookup players by their portal identity for this platform

platform

Lookup players by their platform identity. Will override identity_platform if set.

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

Lookup players by their platform identity. Will override identity_platform if set.

identities

Lookup players by their Portal Identity

Array<string>
default:

Lookup players by their Portal Identity

Responses

200

Successful Response

Lookup results for a player query

object
display_names

List of display names and the players that match that display name

Array<object>
default:
object
key
additional properties
Array<object>

Response for getting a player’s info

object
player_id
required

Player ID DEPRECATED use player_uuid instead

integer
player_uuid
required

Player UUID

string format: uuid
identity_platforms

DEPRECATED Use identity_platforms_by_platform instead. List of platforms and the players that match that platform user id

object
key
additional properties
Array<object>

Lookup results for a platform user id

object
identity

List of platform user ids and the players that match that platform user id

object
key
additional properties

Response for getting a player’s info

object
player_id
required

Player ID DEPRECATED use player_uuid instead

integer
player_uuid
required

Player UUID

string format: uuid
identity_platforms_by_platform

List of platforms and the players that match that platform user id

object
key
additional properties
Array<object>

Lookup results for a platform user id

object
identity

List of platform user ids and the players that match that platform user id

object
key
additional properties

Response for getting a player’s info

object
player_id
required

Player ID DEPRECATED use player_uuid instead

integer
player_uuid
required

Player UUID

string format: uuid

400

Bad Request

Message only response

object
message
required

Message

string

403

Forbidden

Message only response

object
message
required

Message

string

422

Validation Error

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