Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Get User Scores – Absinthe Docs
Skip to content

Get User Scores

Retrieve a single user’s rank and scores.

API Details

  • Endpoint: GET /users/{user_id}/scores
  • Auth:
    • Bearer JWT (portal user): only allowed when {user_id} matches the authenticated user
    • X-API-Key: allowed (campaign is inferred from the user)
  • Caching: Responses are cached for ~1 minute

Example request (user JWT)

curl -X GET "<PLATFORM_API_BASE_URL>/users/<USER_ID>/scores" \
  -H "Authorization: Bearer <USER_JWT>"

Example response

{
  "user_id": "be9af004-2310-4acf-a2c5-77be909ef560",
  "rank": 42,
  "cached_at": "2025-01-01T00:00:00.000Z",
  "display_name": "Cool Tiger",
  "avatar_url": "https://unavatar.io/x/elonmusk",
  "identities": { "x_username": "elonmusk" },
  "currency_names": { "xp": "XP", "gems": "Gems", "gold": "Gold" },
  "scores": {
    "xp": { "score": 900, "referral_score": 100, "total": 1000 },
    "gems": { "score": 450, "referral_score": 50, "total": 500 },
    "gold": { "score": 225, "referral_score": 25, "total": 250 }
  }
}