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
Lookup players by display names
Lookup players by display names
Lookup players by their portal identity for this platform
Lookup players by their portal identity for this platform
Lookup players by their platform identity. Will override identity_platform if set.
Lookup players by their platform identity. Will override identity_platform if set.
Lookup players by their Portal Identity
Lookup players by their Portal Identity
Responses
200
Successful Response
Lookup results for a player query
object
List of display names and the players that match that display name
object
Response for getting a player’s info
object
Player ID DEPRECATED use player_uuid
instead
Player UUID
DEPRECATED Use identity_platforms_by_platform
instead. List of platforms and the players that match that platform user id
object
Lookup results for a platform user id
object
List of platform user ids and the players that match that platform user id
object
Response for getting a player’s info
object
Player ID DEPRECATED use player_uuid
instead
Player UUID
List of platforms and the players that match that platform user id
object
Lookup results for a platform user id
object
List of platform user ids and the players that match that platform user id
object
Response for getting a player’s info
object
Player ID DEPRECATED use player_uuid
instead
Player UUID
403
Error Codes:
auth_invalid_key_id
- Invalid Authorization - Invalid Key ID in Access Tokenauth_invalid_version
- Invalid Authorization - versionauth_malformed_access
- Invalid Authorization - malformed access tokenauth_not_jwt
- Invalid Authorizationauth_token_expired
- Token is expiredauth_token_format
- Invalid Authorization - {}auth_token_invalid_claim
- Token contained invalid claim value: {}auth_token_sig_invalid
- Token Signature is invalidauth_token_unknown
- Failed to parse tokeninsufficient_permissions
- Insufficient Permissions
object
422
Validation Error