# Tenant & school onboarding

Search tenants, inspect their health and provision approved school workspaces.

Category: Platform
Guide: https://avkul.in/docs/guides/screen-saas-tenants/
Guided sample demo: https://avkul.in/docs/demo/screen-saas-tenants/
Snapshot: 11 October 2026

## Features

- Search and status
- Onboarding
- School creation
- Status changes
- Health scores

## Access and setup

Intended access: Platform administrator
- Platform administrator access.
- Choose the relevant school, academic session or child before working.


## Workflow

1. Search for the tenant before creating one.
2. Review school, owner and plan details.
3. Onboard or update the intended tenant.
4. Inspect the resulting tenant detail.

## Fields and controls

- tenantName (string, declared required)
- slug (string, declared required)
- schoolName (string, declared required)
- schoolCode (string, declared required)
- board (string, optional)
- type (string, optional)
- adminEmail (string, declared required)
- adminPassword (string, declared required)
- adminFirstName (string, declared required)
- adminLastName (string, optional)
- planCode (string, optional)
- status (string, declared required)
- ids (string[], declared required)
- action ('ACTIVATE' | 'SUSPEND' | 'CANCEL', declared required)

## Current limits

- Platform access is distinct from a school role. Online SaaS invoice collection and invitation delivery require configured providers.

## Actual application access

- https://avkul.in/en/saas/tenants

## API reference

- GET /api/v1/saas/tenants — List tenants (search, status filter, paginated); Platform admin
- POST /api/v1/saas/tenants — Onboard a new tenant/school (provisions admin + plan); Platform admin
- PATCH /api/v1/saas/tenants/:id/status — Activate / suspend / cancel a tenant; Platform admin
- POST /api/v1/saas/tenants/bulk-action — Apply activate/suspend/cancel to multiple tenants at once; Platform admin
- GET /api/v1/saas/tenants/health/scores — Composite health score per tenant (status, overdue invoices, login recency, trial runway); Platform admin

## Demo access

No login is required for the guided sample demo. Its fictional records and actions stay in this browser tab; they do not modify ERP records or send messages/payments. An assigned account is required for the actual ERP links.

Source inventory checked on 11 October 2026. This source inventory is not a certification of every external provider or device flow.