GET
/api/v1/studentsList
student:viewSCREEN GUIDE · 11 OCT 2026
Student directory
Use student directory in the school workspace. Maintain student profiles, guardians and documents, and manage campus release or school exit.
OVERVIEW
What you can do
01
Download Template
02
Export to Excel
03
List
04
Create
BEFORE YOU BEGIN
Access & setup
Intended access: Assigned account with the required permissions.
- A school account with the permissions shown below.
- Choose the relevant school, academic session or child before working.
Required permission keys
student:viewstudent:createUse 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
Create or open the student profile
A school account with the permissions shown below.
- 02
Review guardian contacts and required documents
Export to Excel is part of the documented workflow.
- 03
Use the gate-pass workflow for an authorized early release
List is part of the documented workflow.
- 04
Use clearance and exit workflows for withdrawal or transfer
Review the result in the connected record or workspace before moving on.
Fields & controls
The screen exposes the following context or input controls. Required fields are validated by the live application.
- Admission No
- First name
- Last name
- Gender
- Section
CURRENT BEHAVIOUR
Rules & current limits
- Campus release is distinct from withdrawal from the school rolls. Transfer certificates require a valid exited record.
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 student directory
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.
2 source-declared operations
POST
/api/v1/studentsCreate
student:createDeclared request fields: firstName (required), middleName (optional), lastName (optional), admissionNo (required), rollNo (optional), gender (optional), dateOfBirth (optional), bloodGroup (optional), sessionId (optional), classId (optional), sectionId (optional), admissionDate (optional), phone (optional), email (optional).
Open the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.