Review existing tenants

Step 1 of 3 in Onboard a tenant.

Start by reading what the platform already holds. Platform > Tenants in the Admin Console and listTenants over REST return the same list: id, slug, name and status for every customer tenant. An empty list on a fresh platform is expected.

Loading example...

Loading example...

Read a candidate tenant with getTenant when a similar name or slug already exists. The slug becomes the tenant host label, usually https://{slug}.{base-domain}, and changing it after credentials and clients exist is disruptive, so a duplicate is far more expensive to unpick than to avoid.

Both calls are Platform Admin operations on the platform origin and use platform operator authorization. They never accept a service client token.

Next

Continue with step 2, Register the tenant.