Skip to main content
GET
Get a user's PeridotID level

Authorizations

pid_access
string
cookie
required

JWT access token set by /auth/google/callback or /auth/refresh

Path Parameters

pid
string
required

The user's permanent PID (e.g. ifal@pid)

Pattern: ^[a-z0-9_]{3,20}@pid$

Response

The user's level summary

Authoritative level summary, read live from PeridotID. Apps must NOT persist this — no XP duplication in app DBs; re-read it instead.

pid
string
required
Pattern: ^[a-z0-9_]{3,20}@pid$
level
integer
required

Current level (starts at 1)

Required range: x >= 1
total_xp
integer
required

Cumulative XP (JSON-safe integer)

Required range: x >= 0
current_level_xp
integer
required

XP marking the start of the current level

Required range: x >= 0
progress_percentage
number
required

Progress within the current level band (0–100, 100 at cap)

Required range: 0 <= x <= 100
next_level_xp
integer | null

XP marking the next level; null at the max-level cap