x-cpod-domain: tenants

Tenants

Tenant management — provision, configure, and lifecycle-manage platform tenants.

Try in explorer client.tenants

Tenant

A top-level platform tenant with its own isolated data and configuration.

REST path/api/v1/tenants

Operations

listgetcreateupdatedelete

SDK

// list — returns only your records; add filters/search:
await client.tenants.list()

// create:
await client.tenants.create({
  id: "rec_01HXEXAMPLE",
  name: "example name",
  slug: "example slug",
  status: "active",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
})

Field	Type	Description
id*	uuid	Tenant UUID.
name*	string	Tenant display name.
slug*	string	URL-safe slug identifier.
status*	enum	Tenant lifecycle status.`activesuspendedprovisioningdeprovisioning`
plan	enum	Subscription plan.`freestarterproenterprise`
settings	json	Tenant-level configuration settings.
created_at*	date-time	Provisioning timestamp.
updated_at*	date-time	Last update timestamp.

Docs

Tenant