Sign in

Balance

GET https://{organization}.myguper.com/api/register/person/{personId}/tier

Returns the current tier balance for a person — active points, current level id, next level name and how many points are missing to reach it. The current level name is not in the payload; resolve it from the tier configuration using levelId (see Tier config — Read).

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Path parameters

Name Type Description
personId * integer Internal Guper person ID.

Responses

{
    "person":       44,
    "activePoints": 2350,
    "levelId":      2,
    "nextLevel":    "Gold",
    "pointsToNext": 2650
}
Copied to clipboard