School Link

These endpoints are used for teachers to create and manage students. This API is currently restricted. Please contact us if you would like these features unlocked for your partner account.

put
Add Teacher Permissions

https://api.playportal.io/user/v1/edu/teacher
Adds teacher permissions to a parent or adult account.
Request
Response
Headers
Authorization
required
string
Authorization token generated by logging in.
200: OK
Teacher permissions added.
{
"success": true
}

put
Create a Student Account

https://api.playportal.io/user/v1/edu/student
Creates a new account for a student. Student accounts are always anonymous, which means they are not visible for any other users and have reduced platform permissions.
Request
Response
Body Parameters
handle
required
string
Handle (account name) for the student.
firstName
required
string
Student's first name.
lastName
required
string
Student's last name.
dateOfBirth
required
string
Student's date of birth, formatted dd/mm/yyyy.
password
required
string
Password for the student.
200: OK
Student created successfully.
{
"handle": "@new-user",
"firstName": "New",
"lastName": "User",
"userType": "child",
"accountType": "Kid",
"country": "US",
"profilePic": null,
"coverPhoto": null,
"userId": "db261424e88ca80e0091f2c26d876bd48fb7eeb61ce52dcece98a614cc0c2519060fb611e21cdd149d0c4ab9a73b4e69b129bc3e0cfc6ae854838003db631774567ea9d924fd64ffab61a4ad1162b6b0d6$193dd51770c794c88ac8b695e7910243",
"anonymous": true,
"parentFlags": {
"cameraDisabled": false,
"proximityFriends": false
}
}

get
Get List of Students

https://api.playportal.io/user/v1/students
Retrieves all students belonging to the requesting teacher.
Request
Response
Query Parameters
limit
optional
number
page
optional
number
200: OK
{
"docs": [{
"handle": "@new-user",
"firstName": "New",
"lastName": "User",
"userType": "child",
"accountType": "Kid",
"country": "US",
"profilePic": null,
"coverPhoto": null,
"userId": "db261424e88ca80e0091f2c26d876bd48fb7eeb61ce52dcece98a614cc0c2519060fb611e21cdd149d0c4ab9a73b4e69b129bc3e0cfc6ae854838003db631774567ea9d924fd64ffab61a4ad1162b6b0d6$193dd51770c794c88ac8b695e7910243",
"anonymous": true,
"parentFlags": {
"cameraDisabled": false,
"proximityFriends": false
}
}],
"total": 1,
"limit": 10,
"page": 1,
"pages": 1
}

post
Remove a Student From Your Class

https://api.playportal.io/user/v1/student/remove
Removes a student from your class. It does not delete the student's account.
Request
Response
Body Parameters
studentId
required
string
User ID of the student you want to remove.
200: OK
{
"success": true
}