Docs home

Class Attendance Report

Returns the sessions of one class (subject batch) with each student's attendance. Use it to build attendance reports or to find the `attendance_id` of a session before editing, cancelling or marking it.

GET/class/attendance
Class Attendance Report
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/class/attendance?class_id=121333&start=1685557800&end=1688149799&response_type=1' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
    "code": 200,
    "message": "Success",
    "payload": {
        "attendance": [
            {
                "id": 13731,
                "taken_by": 78429,
                "taken_by_name": "Geetha K",
                "class_date": 1722450600,
                "start_time": 540,
                "end_time": 600,
                "status": 1,
                "taken_at": 1722482918,
                "signin_by": 78429,
                "signin_by_name": "Geetha K",
                "class_name": "Tech Mahindra | Live Session",
                "class_id": 3794,
                "total_students": 9,
                "present": 9,
                "admin_data": {
                    "canChangeTime": null,
                    "canChangeDate": null,
                    "pay": 0
                },
                "student_data": [
                    {
                        "studentId": 111814,
                        "name": "Devi Priya Siddabattula",
                        "status": 1,
                        "remarks": "",
                        "user_status": 1,
                        "user_status_time": 0,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": 0,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "9848920488",
                        "reg_id": "9345657696",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "ds001028999@techmahindra.com"
                    },
                    {
                        "studentId": 111816,
                        "name": "Kalavakuri Venkata Sudharani",
                        "status": 1,
                        "remarks": "",
                        "user_status": 1,
                        "user_status_time": 0,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": 0,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "8897229780",
                        "reg_id": "9345657698",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "kv001028928@techmahindra.com"
                    },
                    {
                        "studentId": 111808,
                        "name": "Kanduri Lakshmi Priyanka",
                        "status": 1,
                        "remarks": "",
                        "user_status": 1,
                        "user_status_time": 0,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": 0,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "7013525229",
                        "reg_id": "9345657690",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "kp001028996@techmahindra.com"
                    },
                    {
                        "studentId": 111811,
                        "name": "Kumar Abhishek Gourab Bhanja",
                        "status": 1,
                        "remarks": "",
                        "user_status": 1,
                        "user_status_time": 0,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": 0,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "https://d2reerhlyx1yvc.cloudfront.net/User(111811)/110591-IMG_20240418_000932-01.jpeg",
                        "user_state": 1,
                        "contact_number": "7437899896",
                        "reg_id": "9345657693",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "kb001029002@techmahindra.com"
                    },
                    {
                        "studentId": 111813,
                        "name": "Naveen Kurella",
                        "status": 1,
                        "remarks": "",
                        "user_status": 1,
                        "user_status_time": 0,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": 0,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "9390152383",
                        "reg_id": "9345657695",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "nk001028466@techmahindra.com"
                    },
                    {
                        "studentId": 111815,
                        "name": "Praneethkumar Reddy Pamireddy",
                        "status": 1,
                        "remarks": "",
                        "user_status": 1,
                        "user_status_time": 0,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": 0,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "6303115014",
                        "reg_id": "9345657697",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "pp001028925@techmahindra.com"
                    },
                    {
                        "studentId": 111810,
                        "name": "Sarath Babu Varisetty",
                        "status": 1,
                        "remarks": "",
                        "user_status": 1,
                        "user_status_time": 0,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": 0,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "8978578425",
                        "reg_id": "9345657692",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "sv001028924@techmahindra.com"
                    },
                    {
                        "studentId": 111812,
                        "name": "Thanuja Tentu",
                        "status": 1,
                        "remarks": "",
                        "user_status": 1,
                        "user_status_time": 0,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": 0,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "9490807353",
                        "reg_id": "9345657694",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "tt001028992@techmahindra.com"
                    },
                    {
                        "studentId": 111809,
                        "name": "Yaswanth Vaishnava Pushpagiri",
                        "status": 1,
                        "remarks": "",
                        "user_status": 1,
                        "user_status_time": 0,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": 0,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "https://d2reerhlyx1yvc.cloudfront.net/User(111809)/110768-image_cropper_1718800335915.jpg",
                        "user_state": 1,
                        "contact_number": "8317655879",
                        "reg_id": "9345657691",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "yv001028313@techmahindra.com"
                    }
                ],
                "not_marked": 0,
                "class_type": 3,
                "topics_taught": "",
                "pages_taught": "",
                "homework": "",
                "topics_taught_ids": "",
                "signout_at": 1722484813,
                "signout_by": 78429,
                "signout_by_name": "Geetha K",
                "teacher_class_date": 1722450600,
                "teacher_start_time": 540,
                "teacher_end_time": 600,
                "signout_status": 0,
                "is_live": 3,
                "zoom_room_waiting": 0,
                "master_batch_id": 577,
                "master_batch_name": "Tech Mahindra - 2024",
                "individual_batch_attendance": 1,
                "external_class_link": "",
                "virtual_class_type": 1,
                "is_free_enrolment": 0,
                "master_batches": [
                    {
                        "master_batch_id": "577",
                        "master_batch_name": "Tech Mahindra - 2024"
                    }
                ],
                "is_sharable_link_enabled": false,
                "can_join_without_login": false,
                "joining_link": null,
                "feedback_form_id": ""
            },
            {
                "id": 13732,
                "taken_by": 78429,
                "taken_by_name": "Geetha K",
                "class_date": 1722537000,
                "start_time": 540,
                "end_time": 600,
                "status": 0,
                "taken_at": -1,
                "signin_by": 78429,
                "signin_by_name": "Geetha K",
                "class_name": "Tech Mahindra | Live Session",
                "class_id": 3794,
                "total_students": 9,
                "present": 0,
                "admin_data": {
                    "canChangeTime": null,
                    "canChangeDate": null,
                    "pay": 0
                },
                "student_data": [
                    {
                        "studentId": 111814,
                        "name": "Devi Priya Siddabattula",
                        "status": -1,
                        "remarks": "",
                        "user_status": 0,
                        "user_status_time": -1,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": -1,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "9848920488",
                        "reg_id": "9345657696",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "ds001028999@techmahindra.com"
                    },
                    {
                        "studentId": 111816,
                        "name": "Kalavakuri Venkata Sudharani",
                        "status": -1,
                        "remarks": "",
                        "user_status": 0,
                        "user_status_time": -1,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": -1,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "8897229780",
                        "reg_id": "9345657698",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "kv001028928@techmahindra.com"
                    },
                    {
                        "studentId": 111808,
                        "name": "Kanduri Lakshmi Priyanka",
                        "status": -1,
                        "remarks": "",
                        "user_status": 0,
                        "user_status_time": -1,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": -1,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "7013525229",
                        "reg_id": "9345657690",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "kp001028996@techmahindra.com"
                    },
                    {
                        "studentId": 111811,
                        "name": "Kumar Abhishek Gourab Bhanja",
                        "status": -1,
                        "remarks": "",
                        "user_status": 0,
                        "user_status_time": -1,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": -1,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "https://d2reerhlyx1yvc.cloudfront.net/User(111811)/110591-IMG_20240418_000932-01.jpeg",
                        "user_state": 1,
                        "contact_number": "7437899896",
                        "reg_id": "9345657693",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "kb001029002@techmahindra.com"
                    },
                    {
                        "studentId": 111813,
                        "name": "Naveen Kurella",
                        "status": -1,
                        "remarks": "",
                        "user_status": 0,
                        "user_status_time": -1,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": -1,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "9390152383",
                        "reg_id": "9345657695",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "nk001028466@techmahindra.com"
                    },
                    {
                        "studentId": 111815,
                        "name": "Praneethkumar Reddy Pamireddy",
                        "status": -1,
                        "remarks": "",
                        "user_status": 0,
                        "user_status_time": -1,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": -1,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "6303115014",
                        "reg_id": "9345657697",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "pp001028925@techmahindra.com"
                    },
                    {
                        "studentId": 111810,
                        "name": "Sarath Babu Varisetty",
                        "status": -1,
                        "remarks": "",
                        "user_status": 0,
                        "user_status_time": -1,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": -1,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "8978578425",
                        "reg_id": "9345657692",
                        "p_img_url": "",
                        "org_status": 2,
                        "email": "sv001028924@techmahindra.com"
                    },
                    {
                        "studentId": 111812,
                        "name": "Thanuja Tentu",
                        "status": -1,
                        "remarks": "",
                        "user_status": 0,
                        "user_status_time": -1,
                        "user_rating": 0,
                        "user_comments": "",
                        "parent_id": 0,
                        "parent_name": "",
                        "parent_status": 0,
                        "parent_status_time": -1,
                        "parent_rating": 0,
                        "parent_comments": "",
                        "img_url": "",
                        "user_state": 1,
                        "contact_number": "9490807353",
                        "reg_id": "9345657694",
                        "p_img_url": "",
                        "org

Access: Institute admins and tutors who can access the class, students enrolled in it, and custom roles that can view attendance reports. Students only see their own attendance.

Query parameters
class_idintegerrequired
The class.
startUnix timestamp
With end: only sessions starting at or after this time.
endUnix timestamp
With start: only sessions starting before this time. Without start and end, sessions up to today are returned.
user_idinteger
Only this student's attendance.
pageinteger
Send with per_page to get one page of sessions, newest first. Without both, all sessions come back, oldest first.
per_pageinteger
Sessions per page, when paging.
1 returns sessions and students as objects with named fields. Leave it out to get arrays without keys, in the field order below.
1 adds payload.certificates_awarded: for each student (userID), how many certificates they have been awarded.
Purpose unclear from code (affects how archived students are counted).

Response: payload.attendance is a list of sessions. Each session has, in this order: id (the attendance_id), taken_by, taken_by_name, class_date (Unix timestamp), start_time and end_time (minutes after midnight), status (session status: 0 Not signed in, 1 Signed in, 2 Postponed, 3 Cancelled, 4 Late sign-in, 5 Missed sign-in, 6 Excused, 7 Absent), taken_at, signin_by, signin_by_name, class_name, class_id, total_students, present, admin_data (canChangeTime, canChangeDate, pay), student_data, not_marked, class_type (0 Normal, 1 Exam, 2 Extra, 3 Batch-level, 4 Event, 5 Mentoring), topics_taught, pages_taught, homework, topics_taught_ids, signout_at, signout_by, signout_by_name, teacher_class_date, teacher_start_time, teacher_end_time, signout_status, is_live (0 Offline, 1 Live not started, 2 Running, 3 Ended), zoom_room_waiting, master_batch_id, master_batch_name, individual_batch_attendance, external_class_link, virtual_class_type (0 Offline, 1 Zoom Meeting, 5 Zoom Webinar, 6 Custom Link, 8 MS Teams), is_free_enrolment, master_batches, is_sharable_link_enabled, can_join_without_login, joining_link, feedback_form_id, is_woolf_session, organization_id, woolf_resource_id, is_nonmandatory_session, session_duration (seconds).

Each student_data entry has, in order: studentId, name, status (-1 Not marked yet, 0 Absent, 1 Present, 2 Late, 3 Excused, 4 Leave, 5 Not applicable), remarks, the student's and parent's session feedback (user_status, user_status_time, user_rating, user_comments, parent_id, parent_name, parent_status, parent_status_time, parent_rating, parent_comments), img_url, user_state, contact_number, reg_id, p_img_url, org_status, email, learner_status, is_nonmandatory_session, attendance_duration (seconds attended) and presence_intervals.

Notes: Fails with "Invalid Class ID" if you can't access the class. Contact number and email are blank if your institute restricts confidential fields for your role. Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI