Player Profiles

Player Profiles

A profile holds the per-project identity fields for a player: their email and an optional external console id (xuid). Read it with GET /v1/profile and change it with PATCH /v1/profile. Both need the API key and the player session token.

The player's display name lives on their global player account, not on the per-project profile, and it shows up in friends lists. Avatar images and free-form metadata are not part of the profile API today. Store those in Cloud Saves if your game needs them.

Example

curl -s -X PATCH http://localhost:8080/v1/profile \
  -H "Authorization: Bearer <api_key>" \
  -H "X-Session-Token: <access_token>" \
  -H "Content-Type: application/json" \
  -d '{"xuid":"steam:7656119..."}'

A read returns the profile with its id, project_id, external_id, email, xuid, and created_at.

Full reference: the /v1/profile operations.