/api/v1/gate-passList
student:viewUse campus gate passes in the school workspace. Maintain student profiles, guardians and documents, and manage campus release or school exit.
Intended access: Assigned account with the required permissions.
student:viewstudent:updatestudent:managestudent:createUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
A school account with the permissions shown below.
Decision and reason is part of the documented workflow.
Authorised pickup is part of the documented workflow.
Review the result in the connected record or workspace before moving on.
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
studentId | string | Required by declaration |
reason | string | Optional |
expectedOutAt | string | Optional |
expectedBackAt | string | Optional |
releaseToName | string | Optional |
releaseToGuardianId | string | Optional |
approve | boolean | Required by declaration |
guardianId | string | Optional |
releaseRelation | string | Optional |
overrideReason | string | Optional |
notes | string | Optional |
firstName | string | Required by declaration |
middleName | string | Optional |
lastName | string | Optional |
admissionNo | string | Required by declaration |
rollNo | string | Optional |
gender | string | Optional |
dateOfBirth | string | Optional |
bloodGroup | string | Optional |
sessionId | string | Optional |
classId | string | Optional |
sectionId | string | Optional |
admissionDate | string | Optional |
phone | string | Optional |
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
/api/v1/gate-passList
student:view/api/v1/gate-pass/currently-outStudents currently signed out of campus
student:view/api/v1/gate-pass/student/:studentId/pickupsWho is on file to collect this student
student:view/api/v1/gate-passCreate
student:updateDeclared request fields: studentId (required), reason (required), expectedOutAt (optional), expectedBackAt (optional), releaseToName (optional), releaseToGuardianId (optional).
/api/v1/gate-pass/:id/decisionApprove or turn down a gate pass
student:manageDeclared request fields: approve (required), reason (optional).
/api/v1/gate-pass/:id/releaseHand the student over at the gate
student:updateDeclared request fields: guardianId (optional), releaseToName (optional), releaseRelation (optional), overrideReason (optional).
/api/v1/gate-pass/:id/returnMark Returned
student:updateDeclared request fields: notes (optional).
/api/v1/studentsList
student:view/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).
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.