Skip to content

Authentication

API Key

All headless API requests require an API key. Find your key in the SimplerSuite Reviews dashboard under Settings → API.

Pass the key via the X-SwiftReviews-Key header:

Terminal window
curl -H "X-SwiftReviews-Key: sr_your_api_key_here" \
https://reviews-api.simplersuite.co/api/v1/shop/summary

Or as a query parameter:

Terminal window
curl "https://reviews-api.simplersuite.co/api/v1/shop/summary?api_key=sr_your_api_key_here"

Regenerating Keys

If your API key is compromised, regenerate it in Settings → API → Regenerate Key. The old key will immediately stop working.

Base URL

All API endpoints are relative to:

https://reviews-api.simplersuite.co/api/v1