Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required

The UUID of the tenant to retrieve.

Response

Successful operation

A tenant in a multi-tenant environment.

id
string<uuid>
required

The tenant UUID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

customerId
string
required

The external customer ID for this tenant.

Example:

"customer_12345"

name
string
required

Human-readable name for the tenant.

Example:

"Acme Corp"

status
enum<string>
required

The lifecycle status of the tenant.

Available options:
active,
archived
Example:

"active"

created
string<date-time>
required

When the tenant was created.

updated
string<date-time>
required

When the tenant was last updated.