Skip to main content
GET
/
v1
/
gateway
/
sub-tenants
/
combined
JavaScript
import Triglit from 'triglit';

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

// Automatically fetches more pages as needed.
for await (const subTenantListCombinedResponse of client.subTenants.listCombined()) {
  console.log(subTenantListCombinedResponse.id);
}
{
  "data": [
    {
      "subTenantId": "production",
      "isRegistered": true,
      "name": "Production Environment",
      "description": "Main production environment",
      "id": "st_abc123def456",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "page": 0,
  "lastPage": 2
}

Authorizations

X-API-Key
string
header
required

Chave de API do tenant (publishable key ou secret key)

Headers

X-API-Key
string
required

Chave de API do tenant (publishable key ou secret key)

Query Parameters

pageSize
number

Number of sub-tenants per page

Example:

20

page
number

Page number (zero-based)

Example:

0

Response

Combined list of all sub-tenants

data
object[]
required

List of all sub-tenants (both registered and arbitrary/unregistered)

page
number
required

Current page number (zero-based)

Example:

0

lastPage
number
required

Last page number available (zero-based)

Example:

2