Auth

Identity and scope of the calling key

Return the calling API key's **identity and scope** — the canonical "is my key valid, and what can it see?" probe. Returns identity/scope only; it never returns plan or limits (see `/metrics/usage` for usage). `scope_type` is `organization` for a key that reaches the whole tenant, or `inbox` for a key pinned to a single inbox. `scope_id` is the id that scope resolves to — the tenant for an organization key, the inbox for an inbox key. `inbox_id` is present only for an inbox-scoped key.

GET
/auth/me

Return the calling API key's identity and scope — the canonical "is my key valid, and what can it see?" probe. Returns identity/scope only; it never returns plan or limits (see /metrics/usage for usage).

scope_type is organization for a key that reaches the whole tenant, or inbox for a key pinned to a single inbox. scope_id is the id that scope resolves to — the tenant for an organization key, the inbox for an inbox key. inbox_id is present only for an inbox-scoped key.

Authorization

x-api-key<token>

The per-tenant API key. Sent as the x-api-key request header. The key is tenant-scoped.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/auth/me"
{  "api_key_id": "string",  "tenant_id": "string",  "scope_type": "organization",  "scope_id": "string",  "inbox_id": "string"}
{  "name": "string",  "message": "string"}
{  "name": "string",  "message": "string"}