Reference>API Reference

Developer API

JSON over HTTPS on your Zyene workspace. Examples below use https://app.zyenereviews.com—the same host as the dashboard.

Authentication

Create or rotate a key under Integrations → Developer API in the dashboard. Send it on every request as X-API-Key: zy_… or Authorization: Bearer zy_….

Base URL

Point clients at the same host that serves your dashboard (for example https://app.zyenereviews.com). Cross-origin calls from browsers must satisfy the API CORS rules configured for your deployment.

Endpoints

POST/api/v1/requests/send

Send a review request via SMS or email using your API key.

bash

curl -X POST "https://app.zyenereviews.com/api/v1/requests/send" \  -H "X-API-Key: zy_..." \  -H "Content-Type: application/json" \  -d '{"customerName":"Alex","customerPhone":"+18165551234","channel":"sms"}'

GET/api/v1/reviews

List reviews for the business linked to your API key (supports pagination and filters).

bash

curl "https://app.zyenereviews.com/api/v1/reviews?page=1&limit=20&status=pending&minRating=4" \  -H "X-API-Key: zy_..."

GET/api/v1/analytics

Aggregate review and request activity for a time window.

bash

curl "https://app.zyenereviews.com/api/v1/analytics?days=30" \  -H "X-API-Key: zy_..."

Need a new key? Open Integrations in the app (you must be signed in).