Skip to content
StampyWalletDocs
API and webhooks / Reference / Get a customer

Get a customer

GET /v1/clients/:id returns a customer and the state of their loyalty card, stamps, points and rewards to give.

GET/v1/clients/:id

Returns a customer and the state of their card. :id is the UUID returned by POST /v1/clients or GET /v1/clients. An unknown identifier responds 404 client_introuvable.

curl
curl https://app.stampywallet.com/v1/clients/c2a91f3e-7d40-4b8a-a3c5-91e0d6f4b2c7 \
  -H "Authorization: Bearer sw_live_your_key"

The customer object

The same object comes back in every customer route, and in the client field of other responses:

200 OK
{
  "id": "c2a91f3e-7d40-4b8a-a3c5-91e0d6f4b2c7",
  "prenom": "Léa",
  "nom": "Martin",
  "telephone": "0612345678",
  "email": "lea@exemple.fr",
  "carte": "X7k2pQ9mLw",
  "lien_carte": "https://stampywallet.com/c/X7k2pQ9mLw",
  "cree_le": "2026-10-22T09:14:03.120Z",
  "etat": {
    "mode": "tampons",
    "tampons": 3,
    "points": null,
    "objectif": 10,
    "restants": 7,
    "prochaine_recompense": { "seuil": 10, "libelle": "A free coffee" },
    "recompenses_disponibles": [
      { "id": "504c8734-3bbd-4fe9-95f8-7a67c8239dab", "libelle": "A free coffee", "seuil": 10,
        "piste": "normal", "obtenue_le": "2026-10-20T16:03:44.000Z", "expire_le": null }
    ],
    "recompenses_obtenues": 1,
    "dernier_passage": "2026-10-22T09:20:00.000Z",
    "premium": null
  }
}
FieldMeaning
carteThe card code, the one in its QR code
lien_carteThe card page, which offers to add it to Apple Wallet or Google Wallet
etat.tampons, etat.pointstampons in stamps and tiers modes, points in points mode; the other one is null
etat.restantsWhat is missing before the next reward
etat.recompenses_disponiblesRewards earned, not yet given: their id is used to give them
etat.premium{ nom, tampons, objectif, restants } when the business has opened the second counter, otherwise null

Note : identifiers are UUIDs. cli_, pas_ or rec_ prefixes in front of a UUID are accepted as input, and ignored.

Updated

Was this page helpful?