achievements

Get player achievements (v3)

Returns a flat list of individual achievement records for a specific player using the v3 API.

Enhanced Data

This endpoint provides detailed per-achievement data, including:

  • Progress tracking - Current vs target requirements for each achievement
  • Unlock timestamps - When each achievement was earned
  • Media assets - Achievement icons and images
  • Reward details - Gamerscore values and other rewards

Achievement Fields

Each achievement object includes:

  • progressState - Achieved, InProgress, or NotStarted
  • progression - Detailed requirement tracking with current/target values
  • titleAssociations - Which game the achievement belongs to
  • rewards - Gamerscore and other reward info

Response Structure

{
  "achievements": [
    {
      "id": "57",
      "serviceConfigId": "e2f10100-3928-4019-8789-5f12046dcb16",
      "name": "Activated",
      "titleAssociations": [{ "name": "Tom Clancy's The Division", "id": 74304278 }],
      "progressState": "Achieved",
      "progression": {
        "requirements": [{ "id": "...", "current": "17", "target": "1", "operationType": "MAXIMUM", "valueType": "Integer", "ruleParticipationType": "Individual" }],
        "timeUnlocked": "2016-03-14T21:37:25.8148693Z"
      },
      "mediaAssets": [{ "name": "...", "type": "Icon", "url": "https://..." }],
      "platforms": ["XboxOne"],
      "isSecret": true,
      "description": "Get to Manhattan.",
      "lockedDescription": "Get to Manhattan.",
      "productId": "e2f10100-3928-4019-8789-5f12046dcb16",
      "achievementType": "Persistent",
      "participationType": "Individual",
      "timeWindow": null,
      "rewards": [{ "name": null, "description": null, "value": "10", "type": "Gamerscore", "mediaAsset": null, "valueType": "Int" }],
      "estimatedTime": "00:00:00",
      "deeplink": "",
      "isRevoked": false
    }
  ],
  "pagingInfo": {
    "continuationToken": "32",
    "totalRecords": 3206
  }
}

Use Cases

  • Player profiles - Show complete gaming history
  • Achievement tracking - Monitor progress across all games
  • Leaderboards - Compare gamerscore and completion rates
  • Statistics dashboards - Display playtime and game stats

Pagination

Xbox returns 32 achievements per page by default - note the pagingInfo.continuationToken of "32" in the sample above against a totalRecords of 3206. Pass that value back as the continuationToken query param to get the next page:

GET /v3/achievements/player/2533274813410428
GET /v3/achievements/player/2533274813410428?continuationToken=32

Keep following pagingInfo.continuationToken until it returns null. Pass maxItems to request a larger page (e.g. ?maxItems=200) and reduce round trips; omit it to keep Xbox's default of 32.

The token must be sent as a query parameter - it is not read from a header.

Parameters

  • xuid - The Xbox User ID of the player to look up
  • continuationToken (optional) - Page token from pagingInfo.continuationToken
  • maxItems (optional) - Page size; defaults to Xbox's 32
get/v3/achievements/player/{xuid}

Path parameters

xuidstring required

Query parameters

continuationTokenstring
string numeric
OR
number

Response

Player achievement list with title history and stats

{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","description":"The response payload from the upstream Xbox/Microsoft API. The structure varies by endpoint - can be an object, array, or string."}
codeinteger required

HTTP status code from the upstream API. Common values: 200 (success), 400 (bad request), 401 (unauthorized), 404 (not found), 410 (deprecated/gone), 429 (rate limited), 500 (server error)

Example response

{
  "code": 200
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.