API Access add-on — $299/month
Available on Growth and Enterprise plans. Enable it in Settings → API.
Enabling API Access
Open Settings → API tab
Navigate to Settings in your dashboard and click the API tab.
Click "Enable API Access"
This starts the Stripe subscription for the $299/month API Access add-on. Your existing plan billing cycle applies.
Confirm payment
Stripe charges the add-on immediately. API access is enabled within seconds of successful payment.
Generate your first API key
Once enabled, click "Generate New API Key", give it a label (e.g. "Production", "Analytics BI"), and copy the key. Keys are shown only once.
Store your key securely. The full API key is only displayed once immediately after generation. After you close the dialog, only the last 4 characters are visible. If lost, generate a new key and revoke the old one.
Authentication
All API requests must include a Bearer token in the Authorization header:
curl https://opsscaleiq.com/api/v1/locations \ -H "Authorization: Bearer osiq_live_xxxxxxxxxxxx" \ -H "Content-Type: application/json"
API keys are scoped to your organization. Each request is authenticated and rate-limited per key. Keys carry the same permissions as the organization owner.
Rate Limits
The default rate limit is 10,000 requests per day per API key. Enterprise plans can negotiate higher limits. Rate limit headers are returned with every response:
X-RateLimit-Limit: 10000 X-RateLimit-Remaining: 9847 X-RateLimit-Reset: 1703980800
When the limit is exceeded, the API returns 429 Too Many Requests. Implement exponential backoff with a minimum 60-second wait before retrying.
Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/locations | List all locations in your organization |
| GET | /api/v1/reviews | List reviews with optional filters (locationId, minStars, since) |
| GET | /api/v1/ops-scores | Retrieve OpsScore™ data per location |
| GET | /api/v1/alerts | Fetch active and resolved alerts |
| GET | /api/v1/benchmarks | Industry benchmark comparisons |
For full parameter reference, request/response schemas, and code samples in Node.js and Python, see the Developer API Reference →
Managing API Keys
Generating a key
Go to Settings → API, click "Generate New API Key", enter a label, and click Generate. The full key is shown once — copy it immediately.
Multiple keys
You can create multiple keys for different integrations (e.g. "BI Tool", "Internal Reports"). Each key is independently rate-limited.
Revoking a key
Click "Revoke" next to any key in the API settings. Revoked keys stop working immediately. Any requests using a revoked key return 401.
Key rotation
For security, rotate your keys periodically. Generate a new key, update your integration, then revoke the old key.