Everyday Class API
Lists all sessions in a day, week or month for the calendar: class sessions, event sessions and mentoring sessions, with sign-in status and attendance totals. Can also download the list as CSV.
/organization/attendancescurl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/organization/attendances?org_id=<organizationId>&date=01-12-2024' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Sucess",
"classes": [
{
"id": 8779168,
"taken_by": 4060219,
"class_date": 1734546600,
"start_time": 45,
"end_time": 105,
"status": 3,
"taken_at": 1733994630,
"signin_by": 4060219,
"class_type": 3,
"topics_taught": "",
"pages_taught": "",
"homework": "",
"topics_taught_ids": "",
"signout_at": 0,
"signout_by": 4060219,
"teacher_class_date": 1734546600,
"teacher_start_time": 45,
"teacher_end_time": 105,
"signout_status": 0,
"is_live": 1,
"zoom_room_waiting": 0,
"virtual_class_type": 1,
"external_class_link": "",
"gmt_start_time": 1734549300,
"gmt_end_time": 1734552900,
"gmt_teacher_start_time": 1734549300,
"gmt_teacher_end_time": 1734552900,
"pay": 0,
"taken_by_name": "TutorHour",
"signin_by_name": "TutorHour",
"signout_by_name": "TutorHour",
"class_ids": "7248,7249,8940,10271,274877",
"master_batch_ids": "3329,3358,4038,4462",
"master_batch_names": "GRE,JEE batch 1(Chemistry),JEE,aa",
"class_name": "Multiple Class",
"class_id": 274877,
"can_change_date": 0,
"can_change_time": 0,
"schedule_id": 33929,
"is_sharable_link_enabled": "0",
"can_join_without_login": "0",
"join_token": null,
"total_attendances": 0,
"total_present": 0,
"total_absent": 0,
"total_late": 0,
"total_excused": 0,
"total_missing": 0,
"total_leave": 0,
"organization_id": 212,
"is_zoom_poll_taken": 0,
"total": 146,
"present": 0,
"not_marked": 146,
"not_applicable": 0,
"master_batches": [
{
"master_batch_id": "3329",
"master_batch_name": "GRE"
},
{
"master_batch_id": "3358",
"master_batch_name": "JEE batch 1(Chemistry)"
},
{
"master_batch_id": "4038",
"master_batch_name": "JEE"
},
{
"master_batch_id": "4462",
"master_batch_name": "aa"
}
],
"attendance_rank": 39,
"siblings_count": 51
},
{
"id": 7870512,
"taken_by": 3983124,
"class_date": 1734546600,
"start_time": 1275,
"end_time": 1335,
"status": 0,
"taken_at": -1,
"signin_by": 3983124,
"class_type": 0,
"topics_taught": "",
"pages_taught": "",
"homework": "",
"topics_taught_ids": "",
"signout_at": 0,
"signout_by": 3983124,
"teacher_class_date": 1734546600,
"teacher_start_time": 1275,
"teacher_end_time": 1335,
"signout_status": 0,
"is_live": 0,
"zoom_room_waiting": 0,
"virtual_class_type": 0,
"external_class_link": "",
"gmt_start_time": 1734623100,
"gmt_end_time": 1734626700,
"gmt_teacher_start_time": 1734623100,
"gmt_teacher_end_time": 1734626700,
"pay": 0,
"class_name": "MATHEMATICS 1st YEAR",
"schedule_id": null,
"class_id": 77535,
"can_change_date": 1,
"can_change_time": 1,
"taken_by_name": "TutorDefault",
"signin_by_name": "TutorDefault",
"signout_by_name": "TutorDefault",
"master_batch_id": 37463,
"master_batch_name": "PUC 1st Year",
"individual_batch_attendance": 1,
"is_sharable_link_enabled": "0",
"can_join_without_login": "0",
"join_token": null,
"total_attendances": 0,
"total_present": 0,
"total_absent": 0,
"total_late": 0,
"total_excused": 0,
"total_missing": 0,
"total_leave": 0,
"organization_id": 212,
"is_zoom_poll_taken": 0,
"feedback_form_id": "",
"total": 126,
"present": 0,
"not_marked": 126,
"not_applicable": 0,
"master_batches": [],
"attendance_rank": 0,
"siblings_count": 0
}
]
}Access: Institute admins, tutors, plus custom roles that can view schedules or mentoring sessions. Tutors and custom roles without "all batches" access only get sessions of classes they teach or manage.
0 one day (default), 1 the week, 2 the month containing date.25-12-2024. Default: today in your time zone.1 ignores the dates and returns sessions of all time.1 returns only event sessions.1 returns only mentoring sessions.1 downloads the list as "Class List Report.csv" instead of JSON.200SucessShow child attributesHide child attributes
40602194531733994630406021930406021917345466004510501011734549300173455290017345493000TutorHourTutorHourTutorHour7248,7249,8940,10271,2748773329,3358,4038,4462GRE,JEE batch 1(Chemistry),JEE,aaMultiple Class2748770033929000000000212014601460Show child attributesHide child attributes
3329GRE39Notes: Session status: 0 Not signed in, 1 Signed in, 2 Postponed, 3 Cancelled, 4 Late sign-in, 5 Missed sign-in. class_type: 0 Normal, 1 Exam, 2 Extra, 3 Merged (one session for several classes), 4 Event, 5 Mentoring. virtual_class_type: 0 offline, 1 Zoom Meeting, 2 BotSite, 3 GoTo, 4 GoTo Meeting, 5 Zoom Webinar, 6 Custom link, 7 Super Live, 8 MS Teams. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.