Read the current workspace and its settings
The workspace this call is scoped to: its name, slug, plan, status, data region and settings.
/v1/tenants/meViewer- Operation id
- get_my_tenant
- Access
- Any workspace role can call this.
/v1/tenants/meThe workspace this call is scoped to: its name, slug, plan, status, data region and settings.
No provider key is ever returned. Instead, settings carries one
boolean per key, named <key>_set, saying whether one is stored. That is
the only thing this operation will say about a credential.
settings.deployment_mode reads full when nothing has been chosen.
settings.onboarding is passed through as stored and is not interpreted
here, so a client that writes it owns its shape.
Only the settings this route knows about are returned. A key written by something else is stored and not echoed.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: any workspace role, including viewer. Reads are open to every member.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the tenants:read scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/tenants/me"{}