Fidz API — overview
REST endpoints, authentication, common use cases.
Fidz has a public REST API so your POS, Zapier or custom tools can record a stamp without the QR-scan screen. API access is included on the Multi-site plan.
Authentication
Generate an API key in Dashboard → Settings → Developer. Send it as Authorization: Bearer <key> on every request.
Record a stamp
- POST /api/v1/stamp
- Header: Authorization: Bearer fz_...
- Body (JSON): { "phone": "+61...", optional firstName, lastName, email, birthday }
- Idempotent within the minute — two calls for the same customer in the same minute count once.
Response
The endpoint returns JSON: { ok, customerId, pointsAdded, totalPoints, rewardReached, remaining, isNew, deduped }. Use rewardReached to know when the customer has hit their reward, and deduped to detect a repeat call within the same minute.
You can also export or import your full customer list as CSV from Dashboard → Customers.