Get customer loyalty information

Look up a customer in the credential's location by external_id, email or phone. URL-encode the identifier as one path segment (including + in phone numbers). A legacy service fallback also tries personal_id if the initial lookup found no customer. Returns loyalty, promotions and user directly, with no data envelope. loyalty.balance is a monetary equivalent in minor units; points and visits are raw loyalty units. For POINT/MONEY the response includes points; for VISIT it includes visits. A missing customer, and some internal lookup failures, return HTTP 200 with zero balance, empty promotions and null user details. Do not treat that fallback as a successful customer match. The legacy MemberId/DisplayText/Rewards response can also occur for a missing location or an unexpected route error. Check the response shape before offering rewards. This is a read operation: it does not register a customer or redeem a reward. Integrators authenticate with a location-scoped Public API Bearer token.

Integration access is restricted to the credential's location. Pagination, monetary units and response envelopes are endpoint-specific; use the schema below. Do not assume that POST/PATCH requests are safe to retry after a timeout.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json