API Documentation

Submit an NFC tap event. Called automatically by the fan-facing tap flow.

List recent tap events in real-time. Supports filters: product, from (ISO date), to (ISO date).

List all fans for the authenticated organization. Supports query params: page, limit, search (name/email), segment.

Get a single fan by ID including tap history, products owned, and badges earned.

List all products for the organization.

Create a new product. Requires name, category, and sku.

Update an existing product. Pass id in the request body along with fields to update.

List all campaigns (content experiences) for the organization.

Create a new campaign. Requires title and type.

List all content items. Supports query params: type, active.

Create a new content item.

Update a content item by ID.

List all sponsors and their campaign associations for the organization.

Search fans, products, campaigns, sponsors, and pages. Returns categorized results.

List audit log entries. Supports: page, action filter, search.

Log an admin action. Called automatically by the platform on key operations.

Get AI-generated insights and recommendations based on your tap data. Accepts optional query param: q (natural language question).

Retrieve the latest tap events for live monitoring. Supports: product (filter by product name), from/to (ISO date range).