HelpDevelopers
REST API v1
The read API is Scale and Franchise. It does not call Google and it does not post replies.
Base path /api/v1. Send Authorization: Bearer and the organization key. Errors look like { error: { code, message }, request_id }. List endpoints take limit (1 to 100, default 20) and return next_cursor.
Read endpoints need Scale or Franchise and the matching scope. GET /locations is also allowed with events:write on Growth and above. The machine-readable contract is /api/v1/openapi.json, and a longer page is at /developers.
Endpoints that respond
- GET /me — any live key, Growth and above, no secret in the body.
- GET /locations — events:write on Growth and above, or a read scope on Scale and Franchise.
- GET /stats — read:stats. Same calculations as the in-app report, on stored reviews. Nothing is saved and Google is not called.
- GET /review-requests and GET /review-requests/stats — read:requests. Email addresses, phone numbers, and redirect tokens are not included.
- GET /leaderboard — read:stats and the Scale or Franchise leaderboard. One metric at a time. No combined score.
Google review content
Coming soon. GET /reviews, GET /replies, and GET /ratings return 404. Machine-to-machine access to stored Google review text and Google totals is off, including on Scale and Franchise. Do not build a client against those three routes yet. The API never calls Google on your behalf.