Skip to main content
A few lightweight endpoints let you inspect the key you’re calling with and the account behind it — useful for health checks, diagnostics, and surfacing state in your own UI.

​
Is the key valid?

GET /v1/auth/validate confirms the key is active and returns basic identity info (Valid, UserId).

​
When does the key expire?

GET /v1/apiKey/validUntil returns the key’s expiry. A key with no expiry returns 31/12/9999.
Poll validUntil in scheduled jobs to warn before an integration’s key lapses, and rotate it ahead of time.

​
Who does the key belong to?

GET /v1/user/profile returns the account profile behind the key — identifiers, name, and the account’s nest count.

​
What has the account got left?

GET /v1/status returns the account’s subscription state — trial and payment flags, plus the current nesting balance.
For a per-customer breakdown of how the account’s nesting minutes are being consumed across your keys, see Fairness.

​
Is the API up?

GET /public/alive is an unauthenticated health check — no API key needed.