Customers API
Access customer churn data and risk scores.
List Customers
GET /api/v1/public/customers?limit=20&sort=churn_risk_score
Authorization: Bearer rq_live_xxx
# Query Parameters
# limit — max results (default 50, max 100)
# sort — sort by: last_seen_at, churn_risk_score, total_cancelled
# Response
{
"customers": [
{
"id": "uuid",
"email": "alice@example.com",
"name": "Alice Smith",
"total_sessions": 3,
"total_retained": 1,
"total_cancelled": 2,
"churn_risk_score": 0.72,
"last_seen_at": "2026-08-19T14:30:00Z"
}
]
}Get Customer by Email
GET /api/v1/public/customers/alice@example.com
Authorization: Bearer rq_live_xxx
# Response — full customer record with all fieldsChurn Risk Score
Scores range from 0.00 (low risk) to 1.00 (high risk), calculated from:
- 70% — Cancellation rate (cancelled / total sessions)
- 30% — Frequency factor (more cancel attempts = higher risk)
| Score | Risk Level |
|---|---|
| 0.00 – 0.39 | Low |
| 0.40 – 0.69 | Medium |
| 0.70 – 1.00 | High |