Skip to main content
GET
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
Echo the calling key’s effective auth context. Useful for SDK debugging — ‘what scopes do I have, what tenant am I bound to?’ Doesn’t hit the database; returns whatever get_api_key_tenant resolved at request time. Reaching this endpoint successfully proves the key is active, unexpired, and within rate limit (the auth dependency would have rejected otherwise).

Response

WhoamiResponse
string
required
string
required
string
required
string[]
required
boolean
required
Convenience flag: true iff admin is in the key’s scope set. Admin keys can manage other keys, webhooks, and templates.

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026