Expanded Player Object

The Expanded Player Object

This object is only returned for some API end points that require your games secret API key to be passed as some of the returned data is considered more sensitive and should not be displayed publicly.

Example Expanded Player

{
  "id": "e736f918-0868-4e37-aae6-5d3feaccaba9",
  "playerName": "Chuckling Warrior",
  "created": "2026-06-09T05:33:36.9430327Z",
  "consecutiveDailySignIns": 6,
  "successfulSignIns": 121,
  "lastSuccessfulSignIn": "2026-06-09T05:33:36.9490599Z",
  "leaderboardScores": 3,
  "avatars": [
    { ... },
    { ... }
  ],
  "loginProviders": [
    { ... },
    { ... }
  ],
  "totalBucketCloudSaves": 3,
  "totalCloudSaves": 15,
  "totalPrivateCloudSaves": 12,
  "totalBucketCloudSavesSize": 5674000,
  "totalCloudSavesSize": 24348000,
  "totalPrivateCloudSavesSize": 18674000,
  "totalRatings": 5,
  "totalRatingsValue": 875,
  "averageRatingPercent": 68.6275,
  "lastActive": "2026-06-09T05:33:36.9588447Z",
  "emailVerified": true,
  "preventAllEmails": true
}

Object Properties

id guid: A unique ID for this player.
playerName string: The publicly facing player name for this player.
created datetime: The date and time this player was first registered in the game.
consecutiveDailySignIns int32: Total number of consecutive days this player has logged in for.
successfulSignIns int32: Total number of times this player has signed into their account.
lastSuccessfulSignIn datetime?: Date and time of the last successful sign in for this player.
leaderboardScores int32: Total number of leaderboard scores this player has.
avatars Array<Picture>: If player has an avatar, a list of picture objects. Each picture object is the same avatar, but provided in different sizes. Sizes available are based on widths, and the widths 16, 32, 64, 96, 128, 256 will be shown here along with the original avatar size if it doesn't match a width in this list. Some sizes may not show if the width is less than the original avatar width.
loginProviders Array<PlayerLoginProvider>: List of player login provider objects currently assigned to this player.
totalBucketCloudSaves int32: Total number of cloud saves this player has in bucket storage.
totalCloudSaves int32: Total number of cloud saves this player has, private and in buckets.
totalPrivateCloudSaves int32: Total number of cloud saves this player has in their private store.
totalBucketCloudSavesSize int64: Total size in bytes of all this players cloud saves in buckets.
totalCloudSavesSize int64: Total size in bytes of all this players cloud saves, private and in buckets.
totalPrivateCloudSavesSize int64: Total size in bytes of all this players private cloud saves.
totalRatings int32: Total ratings this player has cast.
totalRatingsValue int32: The sum of all this players ratings. The summed values are normalised to a range of 0-255.
averageRatingPercent decimal: The average rating this player casts expressed as a percentage 0-100.
lastActive datetime?: The date and time UTC this player last interacted with these services.
emailVerified bool: True if this player has provided an email address that they have verified via a confirmation email.
preventAllEmails bool: True if all emails to this player will be prevented from being sent. Can only be adjusted by editing the player directly via your CGS account.