Docs home

List All Class Recordings

Lists the class recordings in your current organization, newest first, one page at a time. Covers recordings of class sessions, batch-level sessions, events and mentoring sessions, whether stored on Edmingle's video hosting or added as an external link.

GET/liveclass/library
List All Class Recordings
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/liveclass/library?organization_id=<organizationId>&start=1654626600&end=1654712999&master_batch_id=173&page=1&per_page=<per_page>' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "live_casses": [
    {
      "attendance_id": "21540",
      "vimeo_id": "500821682",
      "live_video_id": "10",
      "video_name": "Testst(15-Jan-2021-5 : 00 pm-5 : 00 pm)",
      "status": "0",
      "class_date": "1610668800",
      "taken_by_id": "1",
      "start_time": "1020",
      "end_time": "1025",
      "taken_by_name": " Gaurav Kapoor",
      "class_name": "Testst",
      "thumbnail_url": "https://i.vimeocdn.com/video/1036179285_295x166.jpg?r=pad",
      "master_batch_name": "Testst",
      "master_batch_id": "735",
      "class_id": "938"
    },
    {
      "attendance_id": "21538",
      "vimeo_id": "500781342",
      "live_video_id": "9",
      "video_name": "Testst(15-Jan-2021-2 : 00 pm-2 : 00 pm)",
      "status": "1",
      "class_date": "1610668800",
      "taken_by_id": "1",
      "start_time": "865",
      "end_time": "870",
      "taken_by_name": " Gaurav Kapoor",
      "class_name": "Testst",
      "thumbnail_url": "https://i.vimeocdn.com/video/1036099696_295x166.jpg?r=pad",
      "master_batch_name": "Testst",
      "master_batch_id": "735",
      "class_id": "938"
    },
    {
      "attendance_id": "21536",
      "vimeo_id": "500771678",
      "live_video_id": "7",
      "video_name": "Testst(15-Jan-2021-1 : 00 am-1 : 00 am)",
      "status": "1",
      "class_date": "1610668800",
      "taken_by_id": "1",
      "start_time": "60",
      "end_time": "90",
      "taken_by_name": " Gaurav Kapoor",
      "class_name": "Testst",
      "thumbnail_url": "https://i.vimeocdn.com/video/1036078778_295x166.jpg?r=pad",
      "master_batch_name": "Testst",
      "master_batch_id": "735",
      "class_id": "938"
    },
    {
      "attendance_id": "21532",
      "vimeo_id": "500841875",
      "live_video_id": "11",
      "video_name": "Testst(14-Jan-2021-1 : 00 am-1 : 00 am)",
      "status": "1",
      "class_date": "1610582400",
      "taken_by_id": "1",
      "start_time": "70",
      "end_time": "85",
      "taken_by_name": " Gaurav Kapoor",
      "class_name": "Testst",
      "thumbnail_url": "https://i.vimeocdn.com/video/1036217512_295x166.jpg?r=pad",
      "master_batch_name": "Testst",
      "master_batch_id": "735",
      "class_id": "938"
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 10,
    "has_more_page": false,
    "total_rows": "4"
  }
}

Access: Institute admins and tutors, plus custom roles that can manage class recordings. Tutors can call it only if your institute lets instructors see class recordings, and they see only recordings of batches they teach or sessions they took. Custom roles without access to all batches are limited the same way.

Query parameters
pageinteger
Page number, starting at 1. Default 1.
per_pageinteger
Results per page. Default 50.
startUnix timestamp
With end: only sessions dated after this time.
endUnix timestamp
With start: only sessions dated before this time.
One batch ID, or several separated by commas. Event and mentoring recordings are left out when this is set.
Class status to include: 0 Active (default), 1 Archived, 3 Completed.
statusstring
Recording status: 0 Unpublished, 1 Published, or 0,1 for both (default).
Only recordings of this session.
Only this recording.
1 leaves out recordings that are only an external link.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
live_cassesobject[]
Spelled this way
Show child attributesHide child attributes
Example: 21540
Example: 500821682
Example: 10
Example: Testst(15-Jan-2021-5 : 00 pm-5 : 00 pm)
0 Unpublished, 1 Published
Example: 0
Unix timestamp
Example: 1610668800
Example: 1
Example: 1020
Minutes after midnight
Example: 1025
Example: Gaurav Kapoor
Example: Testst
Example: https://i.vimeocdn.com/video/1036179285_295x166.jpg?r=pad
Example: Testst
Example: 735
Example: 938
Show child attributesHide child attributes
Example: 1
Example: 10
Example: false
Example: 4

Notes: Numbers come back as strings ("attendance_id": "21540"). Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI