Skip to main content

The Tenant

The tenant is your organisation's account on Klart — the root of the entity hierarchy and the top-level container for its users, clients, cases, and everything else. Every other entity lives inside exactly one tenant.

How you address it​

Unlike the other entities, the tenant has no CRUD endpoints in the public API — you don't create, edit, or delete a tenant here (provisioning is an internal/administrative concern). Instead, you operate inside a tenant by selecting it as a scope:

X-Scope: 42

To discover which scopes (tenants and other entities) your token can act in:

curl "https://api.klart.com/scopes/v1" \
  -H "Authorization: Bearer $KLART_TOKEN"

Each returned scope carries the identifier you pass in X-Scope. See Scopes & Workspaces for how scope narrows what a request can see.

Its role in the model​

  • Container — every client, case, team, group, project, and user belongs to one tenant. Data never crosses tenant boundaries.
  • Top of the access hierarchy — a tenant-level capability often gates whether you can call an endpoint at all, while a narrower scope then filters which records you see (see Permissions).
  • Default scope — most scoped requests are made with X-Scope: tenant:{id} unless you're deliberately working inside a narrower team or client scope.

Relationships​

Tenant
 ├── Users        (actors — members of the organisation)
 ├── Groups / Teams
 ├── Clients ──── Cases
 └── Projects

See also​