List a player's unlocked achievements

Returns the achievements a player has unlocked, in catalog order. The target must be the API key owner or an accepted friend; anyone else returns 404.

GET/players/{id}/achievements

Authorization

x-api-keyAPI key · headerrequired

A user (dp_) or organization (dp_org_) API key with read scopes.

Path parameters

idstringrequired

The entity id.

Responses

200

The player's unlocked achievements.

playerIdstringrequired

achievementsPlayerAchievement[]required

Show properties

Array of PlayerAchievement

idstringrequired

namestringrequired

descriptionstringrequired

raritystringrequired

Allowed:commonuncommonrareepiclegendary

xpintegerrequired

min 0 · max 9007199254740991

categorystringrequired

Allowed:first_stepsscoringcheckoutsgame_winsvolumeengagementrarityconquestcricketcampaigngame_feats

conditionobjectrequired

sortOrderintegerrequired

min -9007199254740991 · max 9007199254740991

unlockedAtstringrequired

400

Invalid request.

messagestringrequired

401

Missing or invalid API key.

messagestringrequired

403

The API key is missing a required scope or is the wrong type for this endpoint.

messagestringrequired

404

Entity not found.

messagestringrequired

429

Rate limit exceeded. See the Retry-After header.

messagestringrequired

500

Internal server error.

messagestringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idpath*The entity id.

Request

curl -X GET 'https://api.dartpilot.app/v1/players/string/achievements' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'

const response = await fetch("https://api.dartpilot.app/v1/players/string/achievements", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.dartpilot.app/v1/players/string/achievements",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "Accept": "application/json"
    },
)

Response

{
  "playerId": "string",
  "achievements": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "rarity": "common",
      "xp": 0,
      "category": "first_steps",
      "condition": {
        "property1": null,
        "property2": null
      },
      "sortOrder": -9007199254740991,
      "unlockedAt": "string"
    }
  ]
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}