Skip to main content

​
API keys

Every request must include your API key. Each key is scoped to a single organization — all data returned is automatically filtered to that organization. You can send the key in any of these headers (all are equivalent):
We recommend using x-spotlight-api-key as the canonical header name for clarity.

​
Getting a key

  1. Go to Settings → API in the Spotlight app.
  2. Copy the key shown on the page.
  3. Keep it secret — treat it like a password.

​
Authentication errors

​
Rate limiting

API keys have a quota on the number of requests per minute, configurable per organization (default: 120 req/min). When the limit is exceeded the API returns 429 Too Many Requests.

​
Example