Skip to main content
GET
/
v1
/
gateway
/
sub-tenants
/
by-id
/
{subTenantId}
JavaScript
import Triglit from 'triglit';

const client = new Triglit({
  apiKey: 'My API Key',
});

const subTenant = await client.subTenants.retrieveByID('production');

console.log(subTenant.id);
{
  "id": "st_abc123def456",
  "tenantId": "tenant_123",
  "subTenantId": "production",
  "name": "Production Environment",
  "description": "Main production environment for customer workflows",
  "isRegistered": true,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Authorizations

X-API-Key
string
header
required

Headers

X-API-Key
string
required

Path Parameters

subTenantId
string
required
Example:

Response

id
string
required
Example:
tenantId
string
required
Example:
subTenantId
string
required
Example:
name
string
required
Example:
isRegistered
boolean
required
Example:
createdAt
string
required
Example:
updatedAt
string
required
Example:
description
string
Example: