GET
/api/v1/saas/tenants/:idTenant detail with schools, subscription and counts
Platform administrator requiredSCREEN GUIDE · 11 OCT 2026
Tenant detail & branding
Review tenant schools, subscription and quotas and maintain supported branding.
OVERVIEW
What you can do
01
School list
02
Subscription and counts
03
Branding
04
Domain settings
05
Additional schools
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
Open the tenant from the list
Platform administrator access.
- 02
Review its schools and subscription
Subscription and counts is part of the documented workflow.
- 03
Save approved branding or add a school within quota
Branding is part of the documented workflow.
- 04
Verify domain setup separately before relying on it
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 |
|---|---|---|
code | string | Required by declaration |
name | string | Required by declaration |
type | string | Optional |
board | string | Optional |
adminEmail | string | Optional |
adminPassword | string | Optional |
adminFirstName | string | Optional |
adminLastName | string | Optional |
brandName | string | Optional |
primaryColor | string | Optional |
faviconUrl | string | Optional |
domain | string | 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 detail & branding
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.
6 source-declared operations
POST
/api/v1/saas/tenants/:id/schoolsAdd a school to an existing tenant (counts against the plan)
Platform administrator requiredDeclared request fields: code (required), name (required), type (optional), board (optional), adminEmail (optional), adminPassword (optional), adminFirstName (optional), adminLastName (optional).
PATCH
/api/v1/saas/tenants/:id/brandingUpdate white-label branding (brand name, color, custom domain)
Platform administrator requiredDeclared request fields: brandName (optional), primaryColor (optional), faviconUrl (optional).
POST
/api/v1/saas/tenants/:id/domainClaim a custom domain — returns a DNS TXT record to publish for ownership proof
Platform administrator requiredDeclared request fields: domain (required).
DELETE
/api/v1/saas/tenants/:id/domainRemove the custom domain and reset verification
Platform administrator requiredPOST
/api/v1/saas/tenants/:id/domain/verifyVerify domain ownership via a real DNS TXT lookup
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.