GET
/api/v1/saas/tenantsList tenants (search, status filter, paginated)
Platform administrator requiredSCREEN GUIDE · 11 OCT 2026
Tenant & school onboarding
Search tenants, inspect their health and provision approved school workspaces.
OVERVIEW
What you can do
01
Search and status
02
Onboarding
03
School creation
04
Status changes
05
Health scores
BEFORE YOU BEGIN
Access & setup
Intended access: Platform administrator.
- Platform administrator access.
- Choose the relevant school, academic session or child before working.
Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
STEP BY STEP
How the workflow works
- 01
Search for the tenant before creating one
Platform administrator access.
- 02
Review school, owner and plan details
Onboarding is part of the documented workflow.
- 03
Onboard or update the intended tenant
School creation is part of the documented workflow.
- 04
Inspect the resulting tenant detail
Review the result in the connected record or workspace before moving on.
Request fields to understand
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
tenantName | string | Required by declaration |
slug | string | Required by declaration |
schoolName | string | Required by declaration |
schoolCode | string | Required by declaration |
board | string | Optional |
type | string | Optional |
adminEmail | string | Required by declaration |
adminPassword | string | Required by declaration |
adminFirstName | string | Required by declaration |
adminLastName | string | Optional |
planCode | string | Optional |
status | string | Required by declaration |
ids | string[] | Required by declaration |
action | 'ACTIVATE' | 'SUSPEND' | 'CANCEL' | Required by declaration |
CURRENT BEHAVIOUR
Rules & current limits
- Platform access is distinct from a school role. Online SaaS invoice collection and invitation delivery require configured providers.
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
LEARN BY DOING
Launch guided demo →Try tenant & school onboarding
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
5 source-declared operations
POST
/api/v1/saas/tenantsOnboard a new tenant/school (provisions admin + plan)
Platform administrator requiredDeclared request fields: tenantName (required), slug (required), schoolName (required), schoolCode (required), board (optional), type (optional), adminEmail (required), adminPassword (required), adminFirstName (required), adminLastName (optional), planCode (optional).
PATCH
/api/v1/saas/tenants/:id/statusActivate / suspend / cancel a tenant
Platform administrator requiredDeclared request fields: status (required).
POST
/api/v1/saas/tenants/bulk-actionApply activate/suspend/cancel to multiple tenants at once
Platform administrator requiredDeclared request fields: ids (required), action (required).
GET
/api/v1/saas/tenants/health/scoresComposite health score per tenant (status, overdue invoices, login recency, trial runway)
Platform administrator requiredOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.