Skip to content

Get client loyalty summary

Request

Returns everything the client can pay with or earn from at the Location in one call: gift cards, Memberships, loyalty cards and referral program settings. Gift cards and Memberships are matched by the client's phone number among those valid at this Location.

Use the status filters to get, for example, only active Memberships before booking. The Business User needs the permission to manage the Location and access to loyalty (or to client loyalty data).

Security
BearerPartnerUser
Path
location_idintegerrequired

Location ID

Example:4564
client_idintegerrequired

Client ID

Example:149853328
Query
abonement_status_slugs[]Array of strings

Return only Memberships with these statuses

Items Enum:"created""active""expired""wasted"
certificate_status_slugs[]Array of strings

Return only gift cards with these statuses

Items Enum:"created""active""expired""redeemed"
Headers
Acceptstringrequired
Default:"application/vnd.api.v2+json"
Content-Typestringrequired
Default:"application/json"
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/4564/client/149853328/loyalty?abonement_status_slugs%5B%5D=created&certificate_status_slugs%5B%5D=created' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json'

Responses

OK

Bodyapplication/json
successboolean
dataobject
metaArray of any
Response
{ "success": true, "data": { "certificates": [ … ], "abonements": [ … ], "loyalty_cards": [], "referral_settings": [ … ] }, "meta": [] }