API authentication and common endpoints
Create a personal API key, authenticate with Bearer, and call the versioned SearchVoro API.
API access starts on Pro. The production base URL is https://app.searchvoro.com/api/v1.
Create and protect a key
- 1Open the Pro console.
- 2Go to Settings → Personal API keys.
- 3Give the key a descriptive name and choose only the permissions required.
- 4Copy the raw key immediately. SearchVoro shows it once and stores only a verifier.
Send the key as a Bearer credential:
curl --fail-with-body -H "Authorization: Bearer $SEARCHVORO_API_KEY" https://app.searchvoro.com/api/v1/billing/entitlementsCommon read endpoints
| Endpoint | Purpose |
|---|---|
| GET /properties | List properties in the caller's account |
| GET /audit-runs | List account-scoped audit runs |
| GET /properties/{propertyId}/report.html | Render the current HTML report |
| GET /properties/{propertyId}/report.csv | Export report scorecards |
| GET /auth/api-keys | List the caller's personal keys |
Write requests require a key with write, *, or the exact method-and-path permission. The default authenticated ceiling for self-service API-enabled plans is 600 requests per minute. A 429 response means retry with backoff.
ImportantNever place API keys in client-side code, URLs, screenshots, or source control. Revoke a key immediately from Settings if it may have been exposed.
Was this helpful?