Get all exit permissions with filters
Retrieve a paginated list of exit permissions based on query parameters and user role
query Parameters
datestring · requiredDate to filter exit permissions (format YYYY-MM-DD)
groupIdsnumber[] · requiredGroup list of Ids
pagenumberCurrent page
pageSizenumberPage size
studentIdnumberStudent ID
keystringFilter by multiples key
typestringType of exit permission
levelsstring[]Level list of students
routeIdnumberRoute ID
fromDatestring · date-timeFrom date
toDatestring · date-timeTo date
absenceTypestringAbsence type
Responses
dataobject[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Create a new exit permission
Create a new exit permission with the provided data
Request Body
datestring · date-time · requiredPermission date
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobject · requiredFixed permission that generated this exit permission
studentIdsnumber[] · requiredStudent list of Ids
messagestringAdditional message
Example: Must return by 18:00
Responses
ExitPermission created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
studentsobject[] · requiredList of host student associated with the exit permission
datestring · date-time · requiredPermission date
createdByobject · requiredUser who created the permission
confirmedByTeacherobject · requiredTeacher who confirmed the exit
confirmedByAdministrativeobject · requiredAdministrative who confirmed the exit
confirmedBySchoolAdministratorobject · requiredSchool administrator who confirmed the exit
confirmedAtstring · date-time · requiredConfirmed at
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobject · requiredFixed permission that generated this exit permission
messagestringAdditional message
Example: Must return by 18:00qrCodestringQR Code
Example: data:image/png;base64,....
Download exit permissions as Excel file
Generate and download an Excel file with exit permissions based on query parameters
query Parameters
datestring · requiredDate to filter exit permissions (format YYYY-MM-DD)
groupIdsnumber[] · requiredGroup list of Ids
pagenumberCurrent page
pageSizenumberPage size
studentIdnumberStudent ID
keystringFilter by multiples key
typestringType of exit permission
Responses
File download URL generated successfully
fileNamestringName of the generated file
urlstringSigned S3 URL to download the file
expiresInnumberURL expiration time in seconds
Get exit permission by ID
Retrieve a specific exit permission by its ID
path Parameters
idnumber · min: 1 · requiredId
Responses
Exit Permission detail
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
studentsobject[] · requiredList of host student associated with the exit permission
datestring · date-time · requiredPermission date
createdByobject · requiredUser who created the permission
confirmedByTeacherobject · requiredTeacher who confirmed the exit
confirmedByAdministrativeobject · requiredAdministrative who confirmed the exit
confirmedBySchoolAdministratorobject · requiredSchool administrator who confirmed the exit
confirmedAtstring · date-time · requiredConfirmed at
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobject · requiredFixed permission that generated this exit permission
messagestringAdditional message
Example: Must return by 18:00qrCodestringQR Code
Example: data:image/png;base64,....
Update an exit permission
Update an existing exit permission by its ID
path Parameters
idnumber · min: 1 · requiredId
Request Body
studentsobject[]List of host student associated with the exit permission
datestring · date-timePermission date
messagestringAdditional message
Example: Must return by 18:00createdByobjectUser who created the permission
qrCodestringQR Code
Example: data:image/png;base64,....confirmedByTeacherobjectTeacher who confirmed the exit
confirmedByAdministrativeobjectAdministrative who confirmed the exit
confirmedBySchoolAdministratorobjectSchool administrator who confirmed the exit
confirmedAtstring · date-timeConfirmed at
statusstring · enumStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobjectFixed permission that generated this exit permission
Responses
Exit Permission updated
Create a route change permission
Create a new route change permission with the provided data
Request Body
datestring · date-time · requiredPermission date
destinationTypestring · enum · requiredEnum values:trusted_addressstudent_routeregular_routestudentIdsnumber[] · requiredStudent list of Ids
messagestringAdditional message
Example: Must return by 18:00trustedAddressIdnumberTrusted address ID
Responses
Route Change created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
studentsobject[] · requiredList of host student associated with the exit permission
datestring · date-time · requiredPermission date
createdByobject · requiredUser who created the permission
confirmedByTeacherobject · requiredTeacher who confirmed the exit
confirmedByAdministrativeobject · requiredAdministrative who confirmed the exit
confirmedBySchoolAdministratorobject · requiredSchool administrator who confirmed the exit
confirmedAtstring · date-time · requiredConfirmed at
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobject · requiredFixed permission that generated this exit permission
destinationTypestring · enum · requiredEnum values:trusted_addressstudent_routeregular_route
messagestringAdditional message
Example: Must return by 18:00qrCodestringQR Code
Example: data:image/png;base64,....
Create a no after school permission
Create a new no after school permission with the provided data
Request Body
datestring · date-time · requiredPermission date
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobject · requiredFixed permission that generated this exit permission
studentIdsnumber[] · requiredStudent list of Ids
destinationTypestring · enum · requiredEnum values:trusted_addressstudent_routeregular_routedepartureTypestring · enum · requiredEnum values:regular_routeroute_changecar_departurepickupModestring · enum · requiredEnum values:SELFCLASSMATE_PARENTTRUSTED_PERSON
messagestringAdditional message
Example: Must return by 18:00trustedPeopleIdnumberTrusted people ID (required when pickupMode is TRUSTED_PERSON)
Example: 1trustedAddressIdnumberTrusted address ID
Responses
No After School created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
studentsobject[] · requiredList of host student associated with the exit permission
datestring · date-time · requiredPermission date
createdByobject · requiredUser who created the permission
confirmedByTeacherobject · requiredTeacher who confirmed the exit
confirmedByAdministrativeobject · requiredAdministrative who confirmed the exit
confirmedBySchoolAdministratorobject · requiredSchool administrator who confirmed the exit
confirmedAtstring · date-time · requiredConfirmed at
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobject · requiredFixed permission that generated this exit permission
destinationTypestring · enum · requiredEnum values:trusted_addressstudent_routeregular_routedepartureTypestring · enum · requiredEnum values:regular_routeroute_changecar_departurepickupModestring · enum · requiredEnum values:SELFCLASSMATE_PARENTTRUSTED_PERSON
messagestringAdditional message
Example: Must return by 18:00qrCodestringQR Code
Example: data:image/png;base64,....
Create an auto pickup permission
Create a new auto pickup permission with the provided data
Request Body
datestring · date-time · requiredPermission date
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobject · requiredFixed permission that generated this exit permission
studentIdsnumber[] · requiredStudent list of Ids
pickupModestring · enum · requiredPickup mode
Enum values:SELFCLASSMATE_PARENTTRUSTED_PERSONExample: SELF
messagestringAdditional message
Example: Must return by 18:00trustedPeopleIdnumberTrusted people ID (required when pickupMode is TRUSTED_PERSON)
Example: 1
Responses
Auto Pickup created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
studentsobject[] · requiredList of host student associated with the exit permission
datestring · date-time · requiredPermission date
createdByobject · requiredUser who created the permission
confirmedByTeacherobject · requiredTeacher who confirmed the exit
confirmedByAdministrativeobject · requiredAdministrative who confirmed the exit
confirmedBySchoolAdministratorobject · requiredSchool administrator who confirmed the exit
confirmedAtstring · date-time · requiredConfirmed at
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobject · requiredFixed permission that generated this exit permission
pickupModestring · enum · requiredPickup mode
Enum values:SELFCLASSMATE_PARENTTRUSTED_PERSONExample: SELF
messagestringAdditional message
Example: Must return by 18:00qrCodestringQR Code
Example: data:image/png;base64,....departureTypestring · enumDeparture type
Enum values:regular_routeroute_changecar_departureExample: regular_route
Create an absence permission
Create a new absence permission with the provided data
Request Body
fixedPermissionobject · requiredFixed permission that generated this exit permission
studentIdsnumber[] · requiredStudent list of Ids
messagestringAdditional message
Example: Must return by 18:00reasonstring · enumReason for absence
Enum values:SICKOTHERMEDICAL_APPOINTMENTTRAVELPERSONAL_MATTERSstartTimestring · date-timeStart time for partial day absence (use this AND endTime OR date for full day)
Example: 2025-01-27T08:00:00.000ZendTimestring · date-timeEnd time for partial day absence (use this AND startTime OR date for full day)
Example: 2025-01-27T16:00:00.000ZendDatestring · date-timeEnd date for absence interval (use with date when fullDay is true to create multi-day absence)
Example: 2025-01-31T00:00:00.000Zdatestring · date-timeDate for full day absence (use this OR startTime/endTime for partial absence)
Example: 2025-01-27T00:00:00.000ZfullDaybooleanWhether the absence is for a full day
Example: true
Responses
Absence created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
studentsobject[] · requiredList of host student associated with the exit permission
datestring · date-time · requiredPermission date
createdByobject · requiredUser who created the permission
confirmedByTeacherobject · requiredTeacher who confirmed the exit
confirmedByAdministrativeobject · requiredAdministrative who confirmed the exit
confirmedBySchoolAdministratorobject · requiredSchool administrator who confirmed the exit
confirmedAtstring · date-time · requiredConfirmed at
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDfixedPermissionobject · requiredFixed permission that generated this exit permission
reasonstring · enum · requiredReason for absence
Enum values:SICKOTHERMEDICAL_APPOINTMENTTRAVELPERSONAL_MATTERS
messagestringAdditional message
Example: Must return by 18:00qrCodestringQR Code
Example: data:image/png;base64,....fullDaybooleanWhether the absence is for a full day
Example: truestartTimestring · date-timeStart time for partial day absence (use this AND endTime OR date for full day)
Example: 2025-01-27T08:00:00.000ZendTimestring · date-timeEnd time for partial day absence (use this AND startTime OR date for full day)
Example: 2025-01-27T16:00:00.000ZendDatestring · date-timeEnd date for absence interval (use with date when fullDay is true to create multi-day absence)
Example: 2025-01-31T00:00:00.000Z
Get fixed route change permissions
Retrieve a paginated list of fixed route change permissions based on query parameters
query Parameters
pagenumberCurrent page
pageSizenumberPage size
schoolIdnumberSchool ID
fromDatestring · date-timeFrom date
toDatestring · date-timeTo date
statusstring · enumStatus
Enum values:PENDINGAPPROVEDREJECTEDstudentNamestringStudent name
routeIdnumberRoute ID
trustedAddressIdnumberTrusted address ID
destinationTypestring · enumDestination type
Enum values:trusted_addressstudent_routeregular_route
Responses
Fixed Route Change Permissions
dataarray[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Create a fixed route change permission
Create a new fixed route change permission that will generate exit permissions automatically
Request Body
schedulestring · date-time · requiredSchedule time for the permission
startDatestring · date-time · requiredStart date for the recurring permission
endDatestring · date-time · requiredEnd date for the recurring permission
weekdaysstring[] · requiredDays of the week when the permission repeats
Enum values:MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYrecurrenceUnitstring · enum · requiredHow often the permission repeats
Enum values:WEEKMONTHrecurrenceValuenumber · min: 1 · requiredNumber of units between repetitions
studentIdsnumber[] · requiredStudent list of Ids
messagestringAdditional message
Example: Must return by 18:00destinationTypestring · enumEnum values:trusted_addressstudent_routeregular_routetrustedAddressIdnumberTrusted address ID
Responses
Fixed Route Change Permission created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
studentsobject[] · requiredList of students for the fixed permission
schedulestring · date-time · requiredSchedule time for the permission
startDatestring · date-time · requiredStart date for the recurring permission
endDatestring · date-time · requiredEnd date for the recurring permission
weekdaysstring[] · requiredDays of the week when the permission repeats
Enum values:MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYrecurrenceUnitstring · enum · requiredHow often the permission repeats
Enum values:WEEKMONTHrecurrenceValuenumber · min: 1 · requiredNumber of units between repetitions
createdBySchoolAdministratorobject · requiredSchool administrator who created the permission
createdByAdministrativeobject · requiredAdministrative who created the permission
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMED
messagestringAdditional message
Example: Must return by 18:00destinationTypestring · enumEnum values:trusted_addressstudent_routeregular_route
Get fixed auto pickup permissions
Retrieve a paginated list of fixed auto pickup permissions based on query parameters
query Parameters
pagenumberCurrent page
pageSizenumberPage size
schoolIdnumberSchool ID
fromDatestring · date-timeFrom date
toDatestring · date-timeTo date
statusstring · enumStatus
Enum values:PENDINGAPPROVEDREJECTEDstudentNamestringStudent name
pickupModestring · enumPickup mode
Enum values:SELFCLASSMATE_PARENTTRUSTED_PERSONtrustedPeopleIdnumberTrusted people ID
Responses
Fixed Auto Pickup Permissions
dataarray[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Create a fixed auto pickup permission
Create a new fixed auto pickup permission that will generate exit permissions automatically
Request Body
schedulestring · date-time · requiredSchedule time for the permission
startDatestring · date-time · requiredStart date for the recurring permission
endDatestring · date-time · requiredEnd date for the recurring permission
weekdaysstring[] · requiredDays of the week when the permission repeats
Enum values:MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYrecurrenceUnitstring · enum · requiredHow often the permission repeats
Enum values:WEEKMONTHrecurrenceValuenumber · min: 1 · requiredNumber of units between repetitions
studentIdsnumber[] · requiredStudent list of Ids
pickupModestring · enum · requiredPickup mode
Enum values:SELFCLASSMATE_PARENTTRUSTED_PERSONExample: SELF
messagestringAdditional message
Example: Must return by 18:00trustedPeopleIdnumberTrusted people ID (required when pickupMode is TRUSTED_PERSON)
Example: 1
Responses
Fixed Auto Pickup Permission created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
studentsobject[] · requiredList of students for the fixed permission
schedulestring · date-time · requiredSchedule time for the permission
startDatestring · date-time · requiredStart date for the recurring permission
endDatestring · date-time · requiredEnd date for the recurring permission
weekdaysstring[] · requiredDays of the week when the permission repeats
Enum values:MONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYrecurrenceUnitstring · enum · requiredHow often the permission repeats
Enum values:WEEKMONTHrecurrenceValuenumber · min: 1 · requiredNumber of units between repetitions
createdBySchoolAdministratorobject · requiredSchool administrator who created the permission
createdByAdministrativeobject · requiredAdministrative who created the permission
statusstring · enum · requiredStatus
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDpickupModestring · enum · requiredPickup mode
Enum values:SELFCLASSMATE_PARENTTRUSTED_PERSONExample: SELF
messagestringAdditional message
Example: Must return by 18:00
Download route change permissions as Excel file
Generate and download an Excel file with route change permissions based on query parameters
query Parameters
pagenumberCurrent page
pageSizenumberPage size
fromDatestring · date-timeFrom date
toDatestring · date-timeTo date
routeIdnumberRoute ID
levelsstring[]Level list of students
statusstringStatus of permission
keystringSearch key for student or creator name
Responses
File download URL generated successfully
fileNamestringName of the generated file
urlstringSigned S3 URL to download the file
expiresInnumberURL expiration time in seconds
Get exit permissions by type
Retrieve a paginated list of exit permissions filtered by type (route-change, auto-pickup, etc.)
path Parameters
typestring · required
query Parameters
pagenumberCurrent page
pageSizenumberPage size
fromDatestring · date-timeFrom date
toDatestring · date-timeTo date
routeIdnumberRoute ID
levelsstring[]Level list of students
statusstringStatus of permission
keystringSearch key for student or creator name
Responses
Exit Permission list by type
idnumber · requiredPermission ID
levelstring · requiredStudent level
studentobject · requiredStudent information
originalRouteobject · requiredOriginal route information
creatorobject · requiredCreator information
statusstring · enum · requiredPermission status
Enum values:PENDINGAPPROVEDREJECTEDCONFIRMEDdatestring · date-time · requiredPermission date
typestring · requiredPermission type
requestedRouteobjectRequested route information
Respond to an exit permission invitation
Accept or decline an exit permission invitation
path Parameters
idnumber · min: 1 · requiredId
Request Body
statusstring · enum · requiredResponse status - accept or reject the permission
Enum values:PENDINGACCEPTEDREJECTEDExample: ACCEPTED
studentIdnumberStudent ID selected by the parent
Example: 123
Responses
Bad request - Invalid request or permission already accepted