Docs home

Get Batch Students

Lists the learners in a batch, one page at a time, with each learner's course progress and attendance. Use it to build a batch roster or a progress report.

GET/masterbatch/{batchId}/students
Get Batch Students
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/masterbatch/{batchId}/students?sort_order=D&sort_by=progress&status=-1&page=1&per_page=20' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
    "code": 200,
    "message": "Success",
    "students": [
        {
            "user_id": 91139236,
            "progress": 71,
            "classusers_start_date": 1728518400,
            "name": "Asit",
            "email": "asit+test9809@edmingle.com",
            "contact_number": "7898093461",
            "contact_number_country_id": 103,
            "registration_number": "1234",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 80,
            "total_conducted_sessions": 9,
            "attendance_percent": 0
        },
        {
            "user_id": 90246298,
            "progress": 71,
            "classusers_start_date": 1701648000,
            "name": "ARD",
            "email": "asit+25@edmingle.com",
            "contact_number": "8907893457",
            "contact_number_country_id": 103,
            "registration_number": "123171",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 1,
            "total_absent": 2,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 80,
            "total_conducted_sessions": 9,
            "attendance_percent": 12
        },
        {
            "user_id": 92169392,
            "progress": 29,
            "classusers_start_date": 1753056000,
            "name": "2nd User",
            "email": "vaibhave@edmingle.com",
            "contact_number": "9878897890",
            "contact_number_country_id": 103,
            "registration_number": "78979723274",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 1,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 6,
            "total_conducted_sessions": 1,
            "attendance_percent": 0
        },
        {
            "user_id": 91506042,
            "progress": 0,
            "classusers_start_date": 1742947200,
            "name": "chsais",
            "email": "chsas@rovae.oin",
            "contact_number": "9428358856",
            "contact_number_country_id": 103,
            "registration_number": "78979723229",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 42,
            "total_conducted_sessions": 5,
            "attendance_percent": 0
        },
        {
            "user_id": 4059900,
            "progress": 0,
            "classusers_start_date": 1742947200,
            "name": "PRQSHANT",
            "email": "asdfadsf@gmci.com",
            "contact_number": "9265075346",
            "contact_number_country_id": 103,
            "registration_number": "162",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 42,
            "total_conducted_sessions": 5,
            "attendance_percent": 0
        },
        {
            "user_id": 3983373,
            "progress": 0,
            "classusers_start_date": 1742947200,
            "name": "Venkatesh Srinivasan Ramchandani  sa",
            "email": "ramchandanivenkatesh@gmail.com",
            "contact_number": "9565123456",
            "contact_number_country_id": 103,
            "registration_number": "1",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 42,
            "total_conducted_sessions": 5,
            "attendance_percent": 0
        },
        {
            "user_id": 91164859,
            "progress": 0,
            "classusers_start_date": 1731456000,
            "name": "hjkhjkg",
            "email": "ckhksdf@gmail.com",
            "contact_number": "8798789878",
            "contact_number_country_id": 103,
            "registration_number": "78979723218",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 76,
            "total_conducted_sessions": 7,
            "attendance_percent": 0
        },
        {
            "user_id": 90023843,
            "progress": 0,
            "classusers_start_date": 1715212800,
            "name": "Hemal Replication",
            "email": "hemal+replicationtest@edmingle.com",
            "contact_number": "9878098909",
            "contact_number_country_id": 103,
            "registration_number": "123153",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 3,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 80,
            "total_conducted_sessions": 9,
            "attendance_percent": 0
        },
        {
            "user_id": 90526374,
            "progress": 0,
            "classusers_start_date": 1708992000,
            "name": "saketh",
            "email": "saketh112@edmingle.com",
            "contact_number": null,
            "contact_number_country_id": 103,
            "registration_number": "78979723128",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 3,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 80,
            "total_conducted_sessions": 9,
            "attendance_percent": 0
        },
        {
            "user_id": 90554508,
            "progress": 0,
            "classusers_start_date": 1708992000,
            "name": "sohan",
            "email": "sohan@reddif.com",
            "contact_number": "9999911111",
            "contact_number_country_id": 103,
            "registration_number": "1919",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 80,
            "total_conducted_sessions": 9,
            "attendance_percent": 0
        },
        {
            "user_id": 90264444,
            "progress": 0,
            "classusers_start_date": 1701043200,
            "name": "Rishabh",
            "email": "rishabh16567572@edmingle.com",
            "contact_number": "8737777777",
            "contact_number_country_id": 103,
            "registration_number": "123174",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 6,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 80,
            "total_conducted_sessions": 9,
            "attendance_percent": 0
        },
        {
            "user_id": 89499424,
            "progress": 0,
            "classusers_start_date": 1678406400,
            "name": "maanju",
            "email": "sbhshs@test.com",
            "contact_number": "9110874906",
            "contact_number_country_id": 103,
            "registration_number": "5258",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 6,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 89122146,
            "progress": 0,
            "classusers_start_date": 1660608000,
            "name": "test bulk",
            "email": "testbulk@edmingle.com",
            "contact_number": "8877556677",
            "contact_number_country_id": 103,
            "registration_number": "6944",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 6,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 89039775,
            "progress": 0,
            "classusers_start_date": 1654128000,
            "name": "Dibyanshu Shrivastava",
            "email": "akr77070@gmail.com",
            "contact_number": "7707081871",
            "contact_number_country_id": 103,
            "registration_number": "4473",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 6,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 89029285,
            "progress": 0,
            "classusers_start_date": 1654128000,
            "name": "Dibyanshu Support",
            "email": "dibyanshu@edmingle.com",
            "contact_number": "7707081871",
            "contact_number_country_id": 103,
            "registration_number": "3795",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 4,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 79946898,
            "progress": 0,
            "classusers_start_date": 1660176000,
            "name": "Hemal Buha",
            "email": "hemal+1011@edmingle.com",
            "contact_number": "8798789878",
            "contact_number_country_id": 103,
            "registration_number": "1250",
            "contact_number_dial_code": "+91",
            "total_present": 1,
            "total_late": 0,
            "total_absent": 5,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 8
        },
        {
            "user_id": 67795160,
            "progress": 0,
            "classusers_start_date": 1643155200,
            "name": "Hiren Chafekar",
            "email": "hiren@edmingle1.com",
            "contact_number": "9687643605",
            "contact_number_country_id": 103,
            "registration_number": "1176",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 50628042,
            "progress": 0,
            "classusers_start_date": 1637798400,
            "name": "meghna",
            "email": "taskmeghna1@gmail.com",
            "contact_number": "7878787878",
            "contact_number_country_id": 103,
            "registration_number": "927",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 6,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 42358737,
            "progress": 0,
            "classusers_start_date": 1631577600,
            "name": "INES",
            "email": null,
            "contact_number": "9089119803",
            "contact_number_country_id": 103,
            "registration_number": "770",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 42355878,
            "progress": 0,
            "classusers_start_date": 1631577600,
            "name": "CHINTAN TEST",
            "email": null,
            "contact_number": "9428124512",
            "contact_number_country_id": 103,
            "registration_number": "769",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 39827908,
            "progress": 0,
            "classusers_start_date": 1630108800,
            "name": "MALLIKA",
            "email": "mallikakonkar2000@gmail.com",
            "contact_number": "7738403717",
            "contact_number_country_id": 103,
            "registration_number": "736",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 6,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 38588127,
            "progress": 0,
            "classusers_start_date": 1629849600,
            "name": "Avi",
            "email": "avi@gmail.com",
            "contact_number": "8877665544",
            "contact_number_country_id": 103,
            "registration_number": "700",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 38473744,
            "progress": 0,
            "classusers_start_date": 1628899200,
            "name": "Chandan",
            "email": "chandan1234@edmingle.com",
            "contact_number": null,
            "contact_number_country_id": null,
            "registration_number": "698",
            "contact_number_dial_code": "",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 37378135,
            "progress": 0,
            "classusers_start_date": 1628208000,
            "name": "binay singh",
            "email": "jrsuri155@gmail.com",
            "contact_number": "6372505305",
            "contact_number_country_id": 103,
            "registration_number": "654",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 6,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 1,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 37251531,
            "progress": 0,
            "classusers_start_date": 1628208000,
            "name": "Test",
            "email": "testemail@gmail.com",
            "contact_number": null,
            "contact_number_country_id": null,
            "registration_number": "648",
            "contact_number_dial_code": "",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 34959342,
            "progress": 0,
            "classusers_start_date": 1627257600,
            "name": "Gouri Sankar",
            "email": "gourisankar@edmingle.com",
            "contact_number": "7366366636",
            "contact_number_country_id": 103,
            "registration_number": "625",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 29628766,
            "progress": 0,
            "classusers_start_date": 1626652800,
            "name": "CHANDAN",
            "email": "chandanui@gmail.com",
            "contact_number": "8888777799",
            "contact_number_country_id": 103,
            "registration_number": "602",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 29153130,
            "progress": 0,
            "classusers_start_date": 1624233600,
            "name": "Chandan Chhabra",
            "email": "chandanchhabra15@gmail.com",
            "contact_number": "9899949541",
            "contact_number_country_id": 103,
            "registration_number": "599",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 6,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "attendance_percent": 0
        },
        {
            "user_id": 29152139,
            "progress": 0,
            "classusers_start_date": 1624233600,
            "name": "Chandan Chhabra",
            "email": "chandanchhabwwwra11@gmail.com",
            "contact_number": "8387772777",
            "contact_number_country_id": 103,
            "registration_number": "598",
            "contact_number_dial_code": "+91",
            "total_present": 0,
            "total_late": 0,
            "total_absent": 0,
            "total_excused": 0,
            "total_missing": 0,
            "total_leave": 0,
            "total_sessions": 84,
            "total_conducted_sessions": 13,
            "atte

Access: Institute admins, admins and tutors, plus custom roles that can view learners or list batches. The batch must belong to one of your organizations.

Path parameters
batch_idintegerrequired
ID of the batch, e.g. masterbatch/2301/students.
Query parameters
pageinteger
Page number, starting at 1. Default 1.
per_pageinteger
Results per page. Default 50.
statusinteger
1 current learners (default; excludes completed and on leave), 3 completed, 4 on leave, 2 removed from the batch, -1 everyone.
1 only learners removed from the batch. Default 0.
1 only free-preview learners, 0 only regular learners (default).
class_idstring
Comma-separated class IDs within the batch, to limit progress and attendance to those classes.
sort_bystring
enroll_on (enrollment order, default) or progress.
A ascending (default) or D descending.

Response: students is an array. Each learner has user_id, name, email, contact_number, contact_number_country_id, contact_number_dial_code, registration_number, classusers_start_date (Unix timestamp they joined the batch), progress (percent of published sections and materials completed, 0 to 100), and attendance counts: total_sessions, total_conducted_sessions, total_present, total_late, total_absent, total_excused, total_missing, total_leave, total_nonmandatory_sessions and attendance_percent. page_context gives page, per_page, total_rows and has_more_page.

Notes: Email and phone come back empty if your institute restricts confidential fields for your role. Errors: "Batch not found in your organization", "Class ID's not found" (the batch has no classes) and "Invalid class_id(s) provided". Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI