Overview and quick start

Read reviews and scores, send invitations and receive webhooks. REST, JSON, HTTPS only. Part of the Pro and Enterprise plans.

Base URL

https://api.proofwell.io/v1

Every path in these docs is relative to this address. Requests over plain HTTP are refused.

Quick start

Create an API key in the business portal (Settings → Developers) with only the permissions your system needs.
Send it as a Bearer token in the Authorization header of every request (or swap it for a 1-hour OAuth access token first).
Call GET /businesses/me to check it works.

Any language

No library to install: plain HTTPS and JSON. Every page has examples in cURL, Node.js, Python and PHP; switch with the buttons above the code.

Plans and limits

The API and webhooks are part of Pro and Enterprise. 10 requests per second per key; per month Pro 100,000 requests, Enterprise 1,000,000 or your own limit.

See plans

OpenAPI 3.1

The whole API as an OpenAPI 3.1 document: every endpoint, parameter, response, error and webhook event. Import it into Postman, Insomnia or a code generator.

Download openapi.json

curl "https://api.proofwell.io/v1/businesses/me" \
  -H "Authorization: Bearer $PROOFWELL_KEY"

Example response (example values)

{
  "id": "biz_example-coffee",
  "name": "Example Coffee Co.",
  "url": "https://example.com/biz/example-coffee",
  "score": 4.3,
  "review_count": 24,
  "proof_share": 0.71,
  "key": {
    "name": "Website reviews feed",
    "permissions": [
      "reviews:read",
      "score:read"
    ]
  },
  "businesses": [
    "…"
  ]
}