Sign in

Customer loyalty-program memberships

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

Whether a customer is a member / associate of a loyalty program and since when. Returns every membership of ONE person inside the organization — active (no leftAt) and historical (with leftAt). A person can belong to more than one tier program; one row per tierConfig.

This is per-customer (membership is the source of truth for "is this person an associate"; the membership tag is only a mirror). It does not aggregate: for org-wide numbers (how many members, revenue from members, member-to-buyer conversion) there is no report endpoint yet — that needs a direct query. Use active-at to know if the person was a member on a given date.

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

[
    {
        "tierConfig": 1,
        "joinedAt":   "2026-04-28 01:14:27",
        "leftAt":     null,
        "isActive":   true,
        "source":     "tag_hook",
        "sourceRef":  "546"
    },
    {
        "tierConfig": 2,
        "joinedAt":   "2025-09-10 17:02:00",
        "leftAt":     "2026-03-15 09:30:00",
        "isActive":   false,
        "source":     "manual",
        "sourceRef":  "admin:42"
    }
]
Copied to clipboard