Guides, Developer Docs & Support Hub
ONBOARDING WORKFLOW
Getting Started with MyEduOS
Setting up your campus on MyEduOS takes minutes. Follow these sequential milestones to transition your administrative, academic, and financial operations to the cloud:
Start a free trial
Sign up with your institution’s name and your work email. You become its admin and get a setup checklist to follow.
Add your institutions and campuses
Add each school or college in your organization, then its campuses. Upload a logo and set brand colors per institution.
Set up the academic year
Create the academic year and its terms, then programs, classes, sections and subjects. Add holidays and events to the academic calendar.
Bring in your staff
Add staff one by one or import a CSV. Imported staff sign in by resetting their password, or through single sign-on if you set it up.
Add students and enroll them
Create student records with their guardians, or convert accepted admission applications straight into students. Then enroll each student into a section.
Give people the right access
Promote other admins, or grant specific permissions, such as managing staff, admissions or academics, to the people who need them.
FREQUENTLY ASKED
Common Questions & Support
I forgot my password. What do I do?
Choose “Forgot password” on the sign-in page. We email you a single-use link; once you set a new password, every older session is signed out.
My account is locked.
Too many wrong passwords or two-factor codes lock the account for a short time to stop guessing attacks. Wait a few minutes and try again, or reset your password.
How do I turn on two-factor authentication?
From your profile, enroll an authenticator app (such as Google Authenticator) and confirm with one code. From then on, sign-in asks for a code after your password.
Can our staff sign in with our Google or Microsoft accounts?
Yes. An admin connects your identity provider (any OIDC provider) under single sign-on, and verifies your email domain. Staff then sign in with their work email, and accounts are created on first login.
How do I see who is signed in to my account?
Your profile lists every signed-in session and device. You can sign any of them out remotely.
Why can’t I see a page my colleague can?
Menus only show what your role and permissions allow. Ask an admin to grant you the permission you need.
Can I get all our data out?
Yes. Students, staff, enquiries and applications export to CSV, and an admin can request a full export of the organization’s data.
DEVELOPER PLATFORM
API Documentation & Webhooks
Every capability in MyEduOS is powered by our versioned REST API. Automate student onboarding, sync fee receipts with external ERPs, or trigger automated SMS/WhatsApp alerts using cryptographic webhooks.
Base URL
Every endpoint lives under /api/v1 and returns JSON with camelCase keys. Responses carry an X-API-Version: v1 header.
Errors
Errors use application/problem+json with type, title, status, code and a requestId you can quote to support.
Pagination
Lists use cursor pagination: pass limit (default 25, max 100) and the after cursor from meta.nextCursor. meta.totalCount gives the total.
Rate limits
Login, registration, password reset and OTP confirmation are rate limited per organization and IP. Over the limit you get 429 with a Retry-After header.
Partner API and API keys
For your own systems, the partner API under /api/partner/v1 takes an API key instead of a user login. Admins issue, rotate and revoke keys under API & Webhooks, each scoped to what it may read or create (institutions, students, staff, academics, attendance, fees).
OpenAPI spec
The partner API publishes an OpenAPI 3.1 description at /api/partner/v1/openapi.json, ready for Postman or a generated client.
Webhooks
Register an HTTPS endpoint and MyEduOS sends signed events, such as a student created, attendance taken, a fee paid, results published or a certificate issued, with a delivery log and a test event.
GET /api/v1/students?limit=25&after=<cursor>
Authorization: Bearer <token>
X-API-Version: v1
200 OK
{
"data": [
{
"id": "stu-10492",
"name": "Aarav Sharma",
"admissionNumber": "ADM-2026-089",
"grade": "10",
"section": "A",
"status": "active"
}
],
"meta": {
"nextCursor": "eyJhZnRlciI6MTA0OTJ9",
"totalCount": 1248
}
}IDENTITY & ACCESS
Authentication Standards
MyEduOS supports multiple authentication pathways: credential sessions with Argon2/Bcrypt hashing, time-based one-time passwords (TOTP), and enterprise Single Sign-On (OIDC / Google Workspace / Microsoft Entra ID).
POST /api/v1/session
Content-Type: application/json
{
"email": "admin@greenvalley.edu",
"password": "••••••••••••",
"otpCode": "849201" // required if 2FA is enrolled
}
201 Created
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expiresAt": "2026-11-04T10:00:00Z",
"user": {
"id": "usr-8812",
"name": "Dr. Sunita Rao",
"email": "admin@greenvalley.edu",
"persona": "school_admin",
"organizationId": "org-greenvalley"
}
}GET /api/v1/session/current verifies the active user session and role matrix.DELETE /api/v1/session revokes token immediately and ends all device sessions.POST /api/v1/sso/login with just an institutional email address.CHANGELOG
Product Updates & Releases
MyEduOS releases continuous updates to enhance platform stability, campus security, and academic productivity.
Student ID Cards, Fleet GPS & Duty Rosters
Launched high-resolution Student ID Card Studio with PVC print layouts, live bus fleet GPS radar with OpenStreetMap telemetry, inward Cheque Clearance register, and faculty Duty Rosters for exam invigilation.
Fees, Razorpay UPI & Demand Notices
Automated Razorpay UPI payment gateway integration, tiered fee demand notices with letterhead export, automated late-fee calculation, and fee receipt voucher generation.
Platform & billing
Free-trial signup, plans with add-on modules, subscriptions and invoices, platform reports, observability, backups and status pages.
AI education layer
An assistant for staff and students that respects permissions, teaching tools, at-risk explanations, safety screening and usage limits. Off until an admin turns it on.
Analytics & reporting
KPI dashboard, trends, institution comparison, academic performance, at-risk students, interventions and scheduled reports.
Portals for teachers, students and parents
A real home for each: today’s classes and registers, homework, results, fees and messages.
Communication
Announcements, emergency alerts, direct messages, templates, and delivery by email, SMS, WhatsApp and in-app.
Library, transport & hostel
Catalogue and circulation; routes, trips and live tracking; rooms, roll call, outpasses and mess.
HR & payroll
Salary structures, monthly payroll, payslips, loans, employee lifecycle, performance reviews and recruitment.
Fees & finance
Fee structures and instalments, invoices, UPI and online payments, receipts, concessions, refunds and reconciliation.
Exams & LMS
Question bank, online exams, marks, results and report cards; online courses, lessons, quizzes and assignments.
Attendance, leave & timetable
Registers, QR and device check-in, leave with approvals, timetables with clash checks and substitutions.
Enrollment & promotion
Enroll students into sections with capacity and roll numbers checked, transfer, withdraw and promote a whole class.
Academic structure & curriculum
Programs, terms, classes, sections, batches, subjects, syllabus units, lessons, teaching assignments and grading scales.
Admissions CRM
Enquiries, admission cycles, applications, documents, interviews, offers and one-step conversion to a student.
Staff management
Staff directory, departments, employment status, documents, and CSV import and export.
Student information
Profiles, guardians, siblings, documents, notes, tags, ID cards, timeline and CSV import.
Identity & security
Login, password reset, two-factor, SSO, sessions, roles, permissions, audit logs and rate limiting.