User Guide
Complete guides for every role
Step-by-step documentation for all nine institution roles and the platform administrator — including invitation onboarding, Razorpay payments, public admissions, and API references.
Invitation-only access
The following roles must be invited by your Institution Admin before signing in: Principal, Teacher, Parent, Student, Accountant, Receptionist, Librarian, Transport Manager.
- Your Institution Admin (School Admin role) creates your account and sends an email invitation (WhatsApp if phone is on file).
- Open the invitation link — it expires in 7 days.
- Set your password on the secure accept-invitation page.
- Sign in at the institution portal with your email and new password.
- Use Forgot Password on the sign-in page if you need to reset later.
School Admin Guide
Full school operations control — academics, users, finance, transport, library, and platform configuration.
Login: /login
Key modules
Step-by-step workflow
Accept invitation
Open the invitation link from Scaleyes, set your password, and activate your school.
GET /auth/invitation/:token → POST /auth/invitation/accept activates Tenant + SCHOOL_ADMIN user.
Sign in
Open the Sign In page, enter your school email and password, then access your School Admin dashboard.
POST /api/v1/auth/login → JWT access + refresh tokens stored in campusopt-auth cookie.
Configure academic year
Go to Academic → create sessions, classes, sections, and subjects before enrolling students.
Modules: /school/academic/sessions, /classes, /sections, /subjects
Onboard users (invitation only)
Invite Principal, Teacher, Parent, Student, Accountant, Receptionist, Librarian, and Transport Manager by email. They cannot sign in until they accept the invitation link.
POST /school/teachers|parents|students|staff — always creates UserInvitation; resend/revoke at /school/invitations/users/:userId/*
Public admissions
Share your admission link with prospective families.
Public form: /apply/{school-slug} → POST /school/admissions/apply
Set fee structures
Define fee plans under Finance, assign to classes, and track collections.
GET/POST /school/finance/structures and /payments
Publish communications
Send announcements, manage events, and enable parent engagement modules.
/school/communication/announcements, /events, /gallery
Review analytics
Use Reports and Analytics for enrollment, fee, and academic KPIs.
/school/reports/overview, /analytics
Secure your account
Use Change Password and enable Two-Factor Auth from the sidebar Account section.
POST /auth/change-password, POST /auth/2fa/enable
Pro tips
- •All eight school roles require invitation — no self-registration.
- •Complete academic setup before bulk student import.
- •Use audit logs in Settings to track staff actions.