eligibility returns everything the app needs to gate a member’s experience in a
single call: their tier and their wallet. It is a convenient first call when a
screen loads, before listing offers or redeeming.
This works with either credential.
GET /v1/eligibility accepts your Org-API-Key
directly or a member token; a server-side caller names the member with
externalUserID.See Authentication. Whether you read sandbox or live data is
selected by the key - see Environments.Get eligibility
eligibility(externalUserID?) calls GET /v1/eligibility and returns a
MemberEligibility. The snippet below reads the tier and balance, then fetches
the full wallet:
curl
externalUserID query parameter is optional. Omit it and the call resolves
to the member the token was minted for; pass it when a machine token acts on a
specific member’s behalf.
Response
string
required
The member’s tier. This is client-set on the member profile and flows
through here - see Members.
Wallet
required
The member’s wallet, embedded so you can gate offers and show a balance without
a second call.
Wallet has these fields:
Every points figure comes with a
...Display sibling in your own currency and
a ...USD sibling in dollars, so you never have to render a points number or do
the conversion yourself. See
Currency configuration for setting what your
currency is worth.Next steps
Wallet
Read the wallet directly, with lifetime totals and currency.
Members
How a member’s tier is set and flows into eligibility.