Public REST API
Available on the Pro Max plan. Pull your review and rating data into a POS, a BI tool, or a custom dashboard. JSON in, JSON out — no SDK required.
Authentication
Every request requires an API key in the Authorization header:
Authorization: Bearer sk_live_•••••••••••••••••••••
Keys are issued from the dashboard. Each key is hashed (SHA-256) at rest — the raw key is shown once at creation and never again. Rotate keys at any time; revocation is instant.
Endpoints
GET /api/public/reviews
Returns the most recent reviews for the business associated with the API key. Supports ?limit=, ?since= (ISO-8601), and ?rating= filters.
{
"success": true,
"data": {
"reviews": [
{
"id": "uuid",
"rating": 5,
"feedback": "Service was great.",
"is_private": false,
"sentiment": "positive",
"topics": ["service"],
"created_at": "2026-05-12T18:30:00Z"
}
]
},
"error": null
}GET /api/public/stats
Returns aggregate stats for your business: total reviews, average rating, breakdown by rating, sentiment counts, and top topics over a window.
{
"success": true,
"data": {
"total_reviews": 482,
"avg_rating": 4.6,
"breakdown": { "5": 320, "4": 110, "3": 30, "2": 15, "1": 7 },
"sentiment": { "positive": 410, "neutral": 50, "negative": 22 }
},
"error": null
}Response shape
Every endpoint returns { success, data, error }. success: false is always paired with a non-null error string. Use HTTP status codes for class (401 unauthorized, 429 rate-limited, 5xx server) and the error field for detail.