Aller au contenu
StampyWalletDocs
API et webhooks / Référence / Lire un client

Lire un client

GET /v1/clients/:id rend un client et l'état de sa carte de fidélité, tampons, points et récompenses à offrir.

GET/v1/clients/:id

Rend un client et l'état de sa carte. :id est l'UUID rendu par POST /v1/clients ou GET /v1/clients. Un identifiant inconnu répond 404 client_introuvable.

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

L'objet client

Le même objet revient dans toutes les routes client, et dans le champ client des autres réponses :

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": "Un café offert" },
    "recompenses_disponibles": [
      { "id": "504c8734-3bbd-4fe9-95f8-7a67c8239dab", "libelle": "Un café offert", "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
  }
}
ChampSens
carteLe code de la carte, celui de son QR
lien_carteLa page de la carte, qui propose l'ajout à Apple Wallet ou Google Wallet
etat.tampons, etat.pointstampons en modes tampons et paliers, points en mode points ; l'autre vaut null
etat.restantsCe qui manque avant la prochaine récompense
etat.recompenses_disponiblesLes récompenses gagnées, pas encore offertes : leur id sert à les offrir
etat.premium{ nom, tampons, objectif, restants } quand le commerce a ouvert le second compteur, sinon null

Note : les identifiants sont des UUID. Des préfixes cli_, pas_ ou rec_ devant un UUID sont acceptés en entrée, et ignorés.

Mis à jour le

Cette page vous a aidé ?