Documentation
API Reference
Users
Get all users with pagination
get
Create a new user
post
Get available languages
get
Get current user information
get
Delete current user account
delete
Get user permissions
get
Get share URL
get
Get users by role
get
Get user by ID
get
Update a user
put
Delete a user
delete
Get user profile by ID and school
get
Delete multiple users
post
Clean tenants in Firebase
delete
Assign roles to user
post
Assign pending users to parents
post
Sync role in Firebase
post
Get user from Firebase
get
Send invite to school
post
Send invite to inactive users by role
post
Send invites to specific users
post
Administrative
Get all administrative users with pagination
get
Create a new administrative user
post
Get administrative user by ID
get
Update an administrative user
put
Delete an administrative user
delete
Upload file with administrative users
post
BulkProcess
/api/v1/bulk-process
get
/api/v1/bulk-process
post
/api/v1/bulk-process/{id}
get
/api/v1/bulk-process/{id}
put
/api/v1/bulk-process/{id}
delete
Role
Get all roles with pagination
get
Create a new role
post
Get all roles
get
Get role by ID
get
Update a role
put
Delete a role
delete
Role User
Get all role-user associations with pagination
get
Assign role to user
post
Get role-user association by ID
get
Update a role-user association
put
Delete a role-user association
delete
Assign multiple roles to user
post
Remove role from user
delete
Parent
Get all parents with pagination
get
Create a new parent
post
Get parent by ID
get
Update a parent
put
Delete a parent
delete
Notification
Get notifications for current user
get
Get notification by ID
get
Update a notification
put
Delete a notification
delete
Send a notification
post
Delete all notifications for current user
delete
Mark notification as read
patch
Notification Preferences
Get notification preferences for current user
get
Create or update notification preferences
post
Get notification preferences by ID
get
Update notification preferences
put
Delete notification preferences
delete
Teacher
Get all teachers with pagination
get
Create a new teacher
post
Get groups for the current teacher
get
Get teacher by ID
get
Update a teacher
put
Delete a teacher
delete
Upload file with teachers
post
School
Initialize modules for a school
post
Get all available school levels
get
Get available levels for current school
get
Get all schools with pagination
get
Create a new school
post
Get school by ID
get
Update a school
put
Delete a school
delete
Get school statistics
get
Generate signed URL for school logo
put
Delete multiple schools
delete
Update school address
put
School Administrator
Get all school administrators with pagination
get
Create a new school administrator
post
Get school administrator by ID
get
Update a school administrator
put
Delete a school administrator
delete
Address
Get all addresses with pagination
get
Create a new address
post
Get address by ID
get
Update an address
put
Delete an address
delete
Application Module
Get all application modules with pagination
get
Create a new application module
post
Get application module by ID
get
Update an application module
put
Delete an application module
delete
Get all modules for a school
get
Get enabled modules for a school
get
Check if module is enabled for a school
get
Toggle module status for a school
put
Bulk toggle modules for a school
put
Family
Get all families with pagination
get
Create a new family
post
Get family members by family number
get
Check if family exists by family number
get
Check parent limit for a family
get
Get family by ID
get
Update a family
put
Delete a family
delete
Upload file with families
post
Validate that a list of family IDs exist
post
DeviceToken
Get all device tokens with pagination
get
Register a device token
post
Get device token by ID
get
Update a device token
put
Delete a device token
delete
Delegates
Get all delegates with pagination
get
Create a new delegate
post
Get delegate by ID
get
Update a delegate
put
Delete a delegate
delete
Group
Get all groups with filters
get
Create a new group
post
Get groups for the current user
get
Get participants of group
get
Remove participants from group
delete
Add participants of group
put
Get group by ID
get
Update a group
put
Delete a group
delete
Upload file with groups
post
Delete multiple groups
delete
Generate signed URL for group
put
Send notification to group members
post
Group Teacher
Get all group-teacher associations with pagination
get
Create a group-teacher association
post
Get group-teacher association by ID
get
Update a group-teacher association
put
Delete a group-teacher association
delete
Group Student
Get all group-student associations with pagination
get
Create a group-student association
post
Get group-student association by ID
get
Update a group-student association
put
Delete a group-student association
delete
Student
Get all students with filters
get
Create a new student
post
Download students as Excel file
get
Get student by ID
get
Update a student
put
Delete a student
delete
Get student detail by ID
get
Delete multiple students
post
Route Student
Get all route-student associations with pagination
get
Create a route-student association
post
Download route students as Excel file
get
Get route students by route ID
get
Get route-student association by ID
get
Update a route-student association
put
Delete a route-student association
delete
Upload file with route students
post
Suspend a route-student association
put
Cancel suspension of route-student association
patch
Delete multiple RouteStudents by IDs
post
Route
Get all routes with pagination
get
Create a new route
post
Get route information for current parent
get
Get route by ID
get
Update a route
put
Delete a route
delete
School Schedule
Get all school schedules with pagination
get
Create a new school schedule
post
Get school schedule by ID
get
Update a school schedule
put
Delete a school schedule
delete
School Configuration
Get all school configurations with pagination
get
Create a new school configuration
post
Get school configuration by ID
get
Update a school configuration
put
Delete a school configuration
delete
School Holiday Cycle
Get all school holiday cycles with pagination
get
Create a new school holiday cycle
post
Get school holiday cycle by ID
get
Update a school holiday cycle
put
Delete a school holiday cycle
delete
Transport
Get all transports for school
get
Create a new transport
post
Get transport by ID
get
Update a transport
put
Delete a transport
delete
Health
Health check
get
Mobile Version
/api/v1/version
get
Permission
Get all permissions with pagination
get
Create a new permission
post
Get permission by ID
get
Update a permission
put
Delete a permission
delete
Documents
Get all documents with pagination
get
Create a new document
post
Get documents for current school
get
Get document by ID
get
Update a document
put
Delete a document
delete
Generate signed URL for document upload
post
Export parents to Excel
get
Export students to Excel
get
Export teachers to Excel
get
Export administrative staff to Excel
get
Export all roles to Excel
get
Reset Data
WARNING! delete the entire database and the firebase users
delete
Legal Documents
Get all legal documents with pagination
get
Create a new legal document
post
Get last legal document
get
Get legal document by ID
get
Update a legal document
put
Delete a legal document
delete
Auth
Send verification code
post
Verify code
post
Verify phone number
post
Pending (Task)
Get all tasks with filters
get
Create a new task
post
Get public task by slug
get
Get pending tasks for current user
get
Get task by ID
get
Update a task
put
Get task detail by ID
get
Delete a task with reason
post
Send reminder for a task
post
Mark task as viewed
patch
Mark task as completed
patch
Revert task completion
patch
Archive a task
patch
Unarchive a task
patch
Generate signed URL for task
post
Session
Get all sessions with filters
get
Create a new session
post
Get session by ID
get
Update a session
put
Delete a session
delete
Delete pending session by task ID
post
Update session slots
put
Publish a session
put
Pending Reminder
Create a task reminder
post
Session Day
Get all session days with pagination
get
Create a new session day
post
Get session day by ID
get
Update a session day
put
Delete a session day
delete
Time Slot
Get all time slots with pagination
get
Create a new time slot
post
Get time slot by ID
get
Update a time slot
put
Delete a time slot
delete
Create an appointment for a time slot
post
Cancel an appointment
put
Event
Get all events with filters
get
Create a new event
post
Get public event by slug
get
Get event by ID
get
Update an event
put
Delete an event
delete
Send reminder for an event
post
Delete an event with reason
post
Exit Permission
Get all exit permissions with filters
get
Create a new exit permission
post
Download exit permissions as Excel file
get
Get public exit permission by slug
get
Get exit permission by ID
get
Update an exit permission
put
Delete an exit permission
delete
Create a route change permission
post
Create a no after school permission
post
Create an auto pickup permission
post
Create an absence permission
post
Confirm an exit permission
patch
Get fixed route change permissions
get
Create a fixed route change permission
post
Get fixed auto pickup permissions
get
Create a fixed auto pickup permission
post
Get generated exit permissions from fixed permission
get
Delete a fixed route change permission
delete
Delete a fixed auto pickup permission
delete
Download route change permissions as Excel file
get
Get exit permissions by type
get
Respond to an exit permission invitation
post
TrustedPeople
Get all trusted people with pagination
get
Create a new trusted person
post
Get trusted person by ID
get
Update a trusted person
put
Delete a trusted person
delete
Update trusted person status
patch
TrustedAddress
Get all trusted addresses with pagination
get
Create a new trusted address
post
Get trusted address by ID
get
Update a trusted address
put
Delete a trusted address
delete
Update trusted address status
patch
Invitations
Get all invitations with filters
get
Create a new invitation
post
Get all invitations created by the user
get
Get all invitations received by the user
get
Download invitations as Excel file
get
Get invitation by ID
get
Update invitation
put
Delete invitation
delete
Update invitation response (accept/decline)
put
Respond to an invitation (accept/decline)
post
Get all responses for an invitation
get
Update the status of an invitation
patch
RouteAvailability
Get all route availabilities with pagination
get
Create a new route availability
post
Get route availability for school
get
Get route availability by route ID
get
Get route availability history for school
get
Get route availability by ID
get
Update a route availability
put
Delete a route availability
delete
Route Availability Student
Get all route availability students with pagination
get
Create a route availability student
post
Download PDF with all routes final status
get
Get route final status
get
Download PDF with route final status
get
Get route availability students by route ID
get
Get route availability student by ID
get
Update a route availability student
put
Delete a route availability student
delete
CronHistory
Get all cron history records with pagination
get
Create a cron history record
post
Get cron history by ID
get
Update a cron history record
put
Delete a cron history record
delete
Lost Article
Get all lost articles with filters
get
Create a new lost article
post
Get all lost article categories
get
Get all lost article statuses
get
Get lost articles claimed by current user
get
Get lost article by ID
get
Update a lost article
put
Delete a lost article
delete
Claim a lost article
patch
Mark lost article as delivered
patch
Cancel claim on lost article
patch
Mark lost article as donated
patch
Send reminder for lost article
patch
Lost Article Reminder
Create a lost article reminder
post
Event reminder
Create an event reminder
post
ScheduleConfiguration
Get schedule configurations for school
get
Create a new schedule configuration
post
Get schedule configuration by ID
get
Update a schedule configuration
put
Delete a schedule configuration
delete
Invitation Student Responses
Get all invitation student responses with filters
get
Create a new invitation student response
post
Get invitation student response by ID
get
Update invitation student response
put
Delete invitation student response
delete
Get all student responses for a specific invitation response
get
Rules Transportation
/api/v1/rules-transportation/content
get
/api/v1/rules-transportation/content
put
Transportation Summary
Get transportation status for the day
get
Get pending authorizations for the day
get
Schemas
Menu
Brein API
Health
API information
Health check
GET
/api/health
Check the health status of the API
Health check ›
Responses
200
503
The Health Check is successful
status
string
Example:
ok
info
object | null
Example:
{"database":{"status":"up"}}
Show properties
error
object | null
Example:
{}
Show properties
details
object
Example:
{"database":{"status":"up"}}
Show properties
Transport
Mobile Version
