Get the achievement catalog

Returns every achievement definition: id, name, description, rarity, XP, category and condition. This is static reference data with no per-player unlocks; use /v1/players/{id}/achievements for a player’s unlocked list.

GET/achievements

Authorization

x-api-keyAPI key · headerrequired

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

Responses

200

The achievement catalog.

catalogAchievement[]required

Show properties

Array of Achievement

idstringrequired

namestringrequired

descriptionstringrequired

raritystringrequired

Allowed:commonuncommonrareepiclegendary

xpintegerrequired

min 0 · max 9007199254740991

categorystringrequired

Allowed:first_stepsscoringcheckoutsgame_winsvolumeengagementrarityconquestcricketcampaigngame_feats

conditionobjectrequired

sortOrderintegerrequired

min -9007199254740991 · max 9007199254740991

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

Request

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

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

import requests

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

Response

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

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}