latestOpenAPI 3.1.0Proprietary2026-08-1095216168.4 KB

db81a447bba9

Tenants

List tenants

Returns all tenants the calling user is a member of. Used by the console to populate the tenant switcher. With API key auth this is scoped to the key's tenant.

get/tenants

Response

Tenants accessible to the caller

created_atstring date-time required

Resource creation timestamp (RFC 3339 UTC).

idinteger required

namestring required

protectedboolean required

When true, deletion is hardened: the DELETE request must include a one-time confirmation code emailed to the tenant address. Obtain the code via PUT /tenants/{tenant_id}/request_code with action = "delete_tenant" and pass it as the code query parameter on the DELETE call.

remarksstring nullable

updated_atstring date-time required

Resource last-update timestamp (RFC 3339 UTC).

Example response

[
  {
    "created_at": "2026-05-20T10:00:00Z",
    "id": 7261845022003200000,
    "name": "Acme",
    "protected": true,
    "updated_at": "2026-05-20T10:00:00Z"
  }
]