Businesses and ProofScore
Read your businesses and their ProofScore through the API, with the rating breakdown behind each score.
In short
The businesses endpoints return the businesses your key can use and the ProofScore of each one, with the star breakdown behind it. The score is the same one shown on your public page and is calculated as described in how ProofScore works; no API call can change it.
GET/businesses/me
GET/businesses/{id}/scorescore:read
Business ids
A business id is biz_ followed by its page address, for example biz_example-coffee. If your key can use more than one business, name one with the business field or parameter.
Score response
| Field | Type | Description |
|---|---|---|
| score | number | ProofScore, 1.0–5.0 (null until the first review) |
| stars | object | Count of published reviews by star (1–5) |
| review_count | integer | Published reviews |
| proof_share | number | Share of reviews with proof (0–1) |
| updated_at | datetime | When the score last changed |
curl "https://api.proofwell.io/v1/businesses/biz_example-coffee/score" \
-H "Authorization: Bearer $PROOFWELL_KEY"Example response (example values)
{
"business_id": "biz_example-coffee",
"score": 4.3,
"stars": {
"1": 2,
"2": 2,
"3": 2,
"4": 6,
"5": 12
},
"review_count": 24,
"proof_share": 0.71,
"updated_at": "2026-09-24T02:40:00.000Z"
}