Get all users with pagination
Retrieve a paginated list of users based on query parameters
query Parameters
pagenumberCurrent page
pageSizenumberPage size
usernamestringUsername filter
rolestring · enumRole filter
Enum values:PARENTDELEGATEDIRECTORTEACHERADMINISTRATIVE_COMMUNICATIONADMINISTRATIVE_LOST_AND_FOUNDADMINISTRATIVE_PERMISSIONS_MANAGERSCHOOL_ADMINISTRATORfirstNamestringFirst name filter
lastNamestringLast name filter
Responses
dataobject[] · requiredData
pagenumberCurrent page
pageSizenumberPage size
totalnumberTotal
lastPagenumberLast page
nextstringNext page (endpoint)
previousstringPrevious page (endpoint)
Create a new user
Create a new user with the provided data
Request Body
emailstring · requiredUsername of User
Default: email@user.comfirstNamestring · requiredFirst name of User
Example: JohnlastNamestring · requiredLast name of User
Example: DoesecondLastNamestring · requiredSecond last name of the user
Example: Smithuidstring · requiredFirebase UID
phonestring · requiredPhone
picturestring · requiredDocument slug
Example: /{tenant-id}/user/{slug}timeZoneOffsetnumber · requiredTimezone offset of the user
Example: -180
preferredLanguagestring · enumThe preferred language of the user
Enum values:SPANISHENGLISHPORTUGUESEFRENCHGERMANMANDARIN_CHINESEKOREANJAPANESEExample: SPANISH
Responses
User created
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
emailstring · requiredUsername of User
Default: email@user.comfirstNamestring · requiredFirst name of User
Example: JohnlastNamestring · requiredLast name of User
Example: DoesecondLastNamestring · requiredSecond last name of the user
Example: Smithuidstring · requiredFirebase UID
phonestring · requiredPhone
picturestring · requiredDocument slug
Example: /{tenant-id}/user/{slug}timeZoneOffsetnumber · requiredTimezone offset of the user
Example: -180
preferredLanguagestring · enumThe preferred language of the user
Enum values:SPANISHENGLISHPORTUGUESEFRENCHGERMANMANDARIN_CHINESEKOREANJAPANESEExample: SPANISH
Get users by role
Retrieve a paginated list of users filtered by role
path Parameters
rolestring · required
query Parameters
levelsstring[] · requiredSchool levels
pagenumberCurrent page
pageSizenumberPage size
gradesnumber[]Grade list
administrativeRolesstring[]Filter by administrative roles
Enum values:PARENTDELEGATEDIRECTORTEACHERADMINISTRATIVE_COMMUNICATIONADMINISTRATIVE_LOST_AND_FOUNDADMINISTRATIVE_PERMISSIONS_MANAGERSCHOOL_ADMINISTRATORkeystringFilter by multiples key
Request Body
levelsstring[] · requiredSchool levels
Example: Middle School
pagenumberCurrent page
pageSizenumberPage size
gradesnumber[]Grade list
administrativeRolesstring[]Filter by administrative roles
Enum values:PARENTDELEGATEDIRECTORTEACHERADMINISTRATIVE_COMMUNICATIONADMINISTRATIVE_LOST_AND_FOUNDADMINISTRATIVE_PERMISSIONS_MANAGERSCHOOL_ADMINISTRATORExample: ["ADMINISTRATIVE_COMMUNICATION","ADMINISTRATIVE_PERMISSIONS_MANAGER"]keystringFilter by multiples key
Responses
Get user by ID
Retrieve a specific user by its ID
path Parameters
idnumber · min: 1 · requiredId
Responses
User detail
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
emailstring · requiredUsername of User
Default: email@user.comfirstNamestring · requiredFirst name of User
Example: JohnlastNamestring · requiredLast name of User
Example: DoesecondLastNamestring · requiredSecond last name of the user
Example: Smithuidstring · requiredFirebase UID
phonestring · requiredPhone
picturestring · requiredDocument slug
Example: /{tenant-id}/user/{slug}timeZoneOffsetnumber · requiredTimezone offset of the user
Example: -180
preferredLanguagestring · enumThe preferred language of the user
Enum values:SPANISHENGLISHPORTUGUESEFRENCHGERMANMANDARIN_CHINESEKOREANJAPANESEExample: SPANISH
Update a user
Update an existing user by its ID
path Parameters
idnumber · min: 1 · requiredId
Request Body
emailstring · requiredUsername of User
Default: email@user.comphonestring · requiredPhone
firstNamestring · requiredFirst name of User
Example: JohnlastNamestring · requiredLast name of User
Example: DoebirthDatestring · date-time · requiredBirth date of the administrative
Example: 1980-02-01T12:30:00.000ZsecondLastNamestring · requiredSecond last name of the user
Example: Smithaddressstring · requiredStreet of the address
Example: Main Stgradesstring[] · requiredGrade level the teacher is responsible for
Example: ["1","2"]levelsstring[] · requiredSchool level the teacher is associated with
Example: ["Primary","Middle School"]picturestring · requiredProfile picture slug
Example: /{tenant-id}/user/{slug}
preferredLanguagestring · enumThe preferred language of the user
Enum values:SPANISHENGLISHPORTUGUESEFRENCHGERMANMANDARIN_CHINESEKOREANJAPANESEExample: SPANISH
Responses
User updated
Get user profile by ID and school
Retrieve a user profile by its ID within the current school context
path Parameters
idnumber · min: 1 · requiredId
Responses
User detail
idnumber · requiredId
createdAtstring · date-time · requiredCreation Date
updatedAtstring · date-time · requiredUpdated Date
emailstring · requiredUsername of User
Default: email@user.comfirstNamestring · requiredFirst name of User
Example: JohnlastNamestring · requiredLast name of User
Example: DoesecondLastNamestring · requiredSecond last name of the user
Example: Smithuidstring · requiredFirebase UID
phonestring · requiredPhone
picturestring · requiredDocument slug
Example: /{tenant-id}/user/{slug}timeZoneOffsetnumber · requiredTimezone offset of the user
Example: -180
preferredLanguagestring · enumThe preferred language of the user
Enum values:SPANISHENGLISHPORTUGUESEFRENCHGERMANMANDARIN_CHINESEKOREANJAPANESEExample: SPANISH
Send invite to inactive users by role
Send invitations to inactive users of a specific role
path Parameters
rolestring · enum · requiredRole of users to send invites to (PARENT, TEACHER, ADMINISTRATIVE, SCHOOL_ADMINISTRATOR)
Enum values:PARENTDELEGATEDIRECTORTEACHERADMINISTRATIVE_COMMUNICATIONADMINISTRATIVE_LOST_AND_FOUNDADMINISTRATIVE_PERMISSIONS_MANAGERSCHOOL_ADMINISTRATOR
Responses
Invite sent to inactive users