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

Find a customer

GET /v1/clients finds a customer by their phone, email or card code.

GET/v1/clients

Finds a customer of the business. Give only one of the three query parameters (otherwise 400 recherche_requise):

Query parameters

telephonestringoptional
The number, URL-encoded (%2B33612345678). It is read in the business's country: 0612345678 and +33612345678 both match.
emailstringoptional
Email address, case-insensitive.
cartestringoptional
The card code, the one in its QR code.

Example

curl
curl "https://app.stampywallet.com/v1/clients?telephone=%2B33612345678" \
  -H "Authorization: Bearer sw_live_your_key"

Response

200 OK
{
  "clients": [
    {
      "id": "c2a91f3e-7d40-4b8a-a3c5-91e0d6f4b2c7",
      "prenom": "Léa",
      "nom": "Martin",
      "telephone": "+33612345678",
      "email": null,
      "carte": "X7k2pQ9mLw",
      "lien_carte": "https://stampywallet.com/c/X7k2pQ9mLw",
      "cree_le": "2026-10-25T10:41:52.120Z",
      "etat": { "mode": "tampons", "tampons": 7, "points": null, "objectif": 10, "restants": 3,
                "prochaine_recompense": { "seuil": 10, "libelle": "A free baguette" },
                "recompenses_disponibles": [], "recompenses_obtenues": 1,
                "dernier_passage": "2026-10-28T08:02:11.000Z", "premium": null }
    }
  ]
}

The list is empty ("clients": []) when nobody matches: this is not an error. When several profiles share the same email or number, the one who came most recently is returned. The fields in detail: the customer object.

Updated

Was this page helpful?