Sign in
latestOpenAPI 3.0.02026-08-2086102148.5 KB

5fc4757128af

Partners Me

Personal VXP rollup (total + current calendar month)

get/v1/partners/me/vxp-summary

Response

totalVxpnumber required
monthlyVxpnumber required
isEnthusiastboolean required

Authoritative Enthusiast flag, read from workos_user.isEnthusiast. Clients render this directly — they must not re-derive it from totalVxp against the threshold.

enthusiastThresholdnumber required

Personal VXP required to reach Enthusiast standing (ENTHUSIAST_VXP_THRESHOLD). Served so the progress bar renders without the client mirroring the backend constant.

enthusiastSincestring nullable required

ISO-8601 timestamp the caller first crossed into Enthusiast standing, or null if they never have.

Example response

{
  "monthly": [
    {
      "month": "2026-04"
    }
  ]
}