List Tenants - Namespace Documentation

Your platform can list every tenant it owns, for example to reconcile them with the customers in your database. Listing also finds a single tenant, because there is no call that fetches one tenant by ID. Listing tenants requires a partner client. The examples start from partnerClient.

List tenants

ListTenants returns tenants in pages. Set limit to choose how many tenants a page holds. A single call returns the first page:

const { tenants } = await partnerClient.tenants.listTenants({ limit: 100 });

for (const tenant of tenants) {
  console.log(tenant.id, tenant.externalAccountId, tenant.visibleName);
}

resp, err := partnerClient.Tenants.ListTenants(ctx, &iamv1beta.ListTenantsRequest{Limit: 100})
if err != nil {
	log.Fatal(err)
}

for _, tenant := range resp.Tenants {
	fmt.Println(tenant.Id, tenant.ExternalAccountId, tenant.VisibleName)
}

Output

tenant_lqrj7qre0ts32 customer-1 Customer 1
tenant_kmtjjrchufgg4 customer-2 Customer 2
tenant_d0s4f2p8ho9ne customer-3 Customer 3

List all tenants

When you have more tenants than one page holds, use the cursor from each response to fetch the next page. Keep requesting pages until the cursor comes back empty.

import type { Tenant } from "@namespacelabs/sdk/proto/namespace/cloud/iam/v1beta/tenants_pb";

async function listAllTenants(): Promise<Tenant[]> {
  const tenants: Tenant[] = [];
  let cursor = "";

  do {
    const page = await partnerClient.tenants.listTenants({ limit: 100, cursor });
    tenants.push(...page.tenants);
    cursor = page.cursor;
  } while (cursor);

  return tenants;
}

for (const tenant of await listAllTenants()) {
  console.log(tenant.id, tenant.externalAccountId, tenant.visibleName);
}

func listAllTenants(ctx context.Context, partnerClient iam.Client) ([]*iamv1beta.Tenant, error) {
	var tenants []*iamv1beta.Tenant
	cursor := ""

	for {
		page, err := partnerClient.Tenants.ListTenants(ctx, &iamv1beta.ListTenantsRequest{
			Limit:  100,
			Cursor: cursor,
		})
		if err != nil {
			return nil, err
		}

		tenants = append(tenants, page.Tenants...)
		if page.Cursor == "" {
			return tenants, nil
		}
		cursor = page.Cursor
	}
}

Output

tenant_lqrj7qre0ts32 customer-1 Customer 1
tenant_kmtjjrchufgg4 customer-2 Customer 2
tenant_d0s4f2p8ho9ne customer-3 Customer 3

Next steps

Update tenants

Rename a tenant and change its labels.

Delete tenants

Remove a tenant when a customer leaves.

Last modified on October 2, 2026

⌘I