Skip to content

Students

Manage your student roster.

OperationEndpointScope
List studentsGET /api/v1/studentsapi:student:read
Create a studentPOST /api/v1/studentsapi:student:write
Get a studentGET /api/v1/students/{studentId}api:student:read
Update a studentPUT /api/v1/students/{studentId}api:student:write
Delete a studentDELETE /api/v1/students/{studentId}api:student:write

List students

GET /api/v1/students?page=1&limit=20&search=
QueryDefaultNotes
page11–1000.
limit201–100.
searchName search.

Returns a paged data object.

Create a student

POST /api/v1/students
FieldTypeRequiredNotes
namestringYes1–200 chars.
groupstring | nullNoUp to 200 chars.
notestring | nullNoUp to 2000 chars.
emailstring | nullNoValid email.
phonestring | nullNoUp to 50 chars.
tagsstring[]NoUp to 50 tags.
json
{ "data": { "created": true } }   // 201

Reaching your plan's roster limit returns 403 with a code and limit.

Get / update / delete

GET    /api/v1/students/{studentId}   →  { "data": { …student } }   (404 if not found)
PUT    /api/v1/students/{studentId}   →  body { name (required), group?, note?, email?, phone?, tags? }
DELETE /api/v1/students/{studentId}   →  delete the student

TechTrans Lab