Skip to main content
The dashboard itself authenticates with a session cookie, but any request can also authenticate with an API key — the same way, whether you’re calling from a script, a backend service, or an integration.

​
Generate a key

  1. Sign in to the dashboard and go to Settings → API keys.
  2. Click Create key, name it something that identifies where it’ll be used (e.g. production-backend).
  3. Copy the key immediately — it’s shown once, in full, and never again.
Creating an API key requires the admin role or higher on your account. Keys act as a full-access grant to your account’s data, scoped to your account only — treat one the way you’d treat a password.

​
Authenticate a request

Send the key in the X-Api-Key header on every request. No other header or query parameter is needed.

​
Scope

An API key resolves to the account that created it — every request made with it sees exactly what that account’s dashboard sees, nothing from any other tenant. There’s currently no per-key permission scoping below the account level; if you need a request path locked down further, use a dedicated key per integration and revoke it independently when needed.

API Reference

See every endpoint you can call with a key.