FalconryScale
DevelopersAPI reference

List the caller's achievements

Returns the caller's total XP, the achievements they have unlocked (newest first), and progress toward each one still locked (e.g. a 30-day weigh-in streak at 12 of 30). Achievements are personal: they count only what the caller logged.

GET
/achievements

Authorization

bearerAuth
headerAuthorizationBearer <token>

A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.

Response Body

List the caller's achievements

application/json
  1. response
totalXp*integer
Range-9007199254740991 <= value <= 9007199254740991
unlocked*array<>
inProgress*array<>
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/achievements'
Example Response
{
  "totalXp": -9007199254740991,
  "unlocked": [
    {
      "achievementId": "string",
      "raptorId": "string",
      "unlockedAt": "string",
      "xpAwarded": 0
    }
  ],
  "inProgress": [
    {
      "achievementId": "string",
      "category": "string",
      "kind": "streak",
      "current": 0,
      "target": 0
    }
  ]
}