GET
/api/v1/live-classesList
live-class:viewSCREEN GUIDE · 11 OCT 2026
Live classes & recordings
Use live classes & recordings in the school workspace. Schedule live lessons, manage their lifecycle and maintain recordings where configured.
OVERVIEW
What you can do
01
List
02
Create
03
Cancel
BEFORE YOU BEGIN
Access & setup
Intended access: Assigned account with the required permissions.
- A school account with the permissions shown below.
- Choose the relevant school, academic session or child before working.
Required permission keys
live-class:viewlive-class:createlive-class:updateUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
STEP BY STEP
How the workflow works
- 01
Create the class for the intended learners
A school account with the permissions shown below.
- 02
Review the scheduled time and class details
Create is part of the documented workflow.
- 03
Start the class and use the available joining experience
Cancel is part of the documented workflow.
- 04
End the session and review an available recording
Review the result in the connected record or workspace before moving on.
Request fields to understand
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
title | string | Required by declaration |
classId | string | Required by declaration |
sectionId | string | Optional |
subjectId | string | Optional |
scheduledAt | string | Required by declaration |
durationMin | number | Optional |
CURRENT BEHAVIOUR
Rules & current limits
- Camera/microphone, media delivery and recordings depend on browser permissions and service configuration; a schedule alone does not prove media connectivity.
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
LEARN BY DOING
Launch guided demo →Try live classes & recordings
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
3 source-declared operations
POST
/api/v1/live-classesCreate
live-class:createDeclared request fields: title (required), classId (required), sectionId (optional), subjectId (optional), scheduledAt (required), durationMin (optional).
POST
/api/v1/live-classes/:id/cancelCancel
live-class:updateOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.