Docs home

List Student Enrolled Classes

Lists the batches and classes a learner is enrolled in within your organizations, with their attendance totals in each. Use it to show a learner's attendance summary.

GET/admin/classes/attendance
List Student Enrolled Classes
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/admin/classes/attendance?user_id=89939898&response_type=1' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "classes": [
    {
      "class_id": 10383,
      "class_name": "1st Course",
      "tutor_name": "Edmingle Admin",
      "total_classes": 3,
      "present": 0,
      "absent": 0,
      "late": 0,
      "excused": 0,
      "start_date": 1676332800,
      "end_date": 1676332800,
      "master_batch_id": 4499,
      "master_batch_name": "Chemistry Crash Courses",
      "classusers_start_date": 1689724800,
      "classusers_end_date": 0,
      "batch_status": 0,
      "cu_status": 2,
      "cu_state": 1,
      "institution_bundle_id": 2213,
      "archived_at": 0,
      "bundle_id": 1980
    },
    {
      "class_id": 10384,
      "class_name": "2nd course",
      "tutor_name": "Edmingle Admin",
      "total_classes": 0,
      "present": 0,
      "absent": 0,
      "late": 0,
      "excused": 0,
      "start_date": 1676332800,
      "end_date": 1676332800,
      "master_batch_id": 4499,
      "master_batch_name": "Chemistry Crash Courses",
      "classusers_start_date": 1689724800,
      "classusers_end_date": 0,
      "batch_status": 0,
      "cu_status": 2,
      "cu_state": 1,
      "institution_bundle_id": 2213,
      "archived_at": 0,
      "bundle_id": 1980
    },
    {
      "class_id": 86267,
      "class_name": "Physics",
      "tutor_name": "Edmingle Admin",
      "total_classes": 23,
      "present": 0,
      "absent": 0,
      "late": 0,
      "excused": 0,
      "start_date": 1637107200,
      "end_date": 1642118400,
      "master_batch_id": 38521,
      "master_batch_name": "Batch 2",
      "classusers_start_date": 1695168000,
      "classusers_end_date": 0,
      "batch_status": 0,
      "cu_status": 1,
      "cu_state": 1,
      "institution_bundle_id": 1515,
      "archived_at": 0,
      "bundle_id": 1369
    },
    {
      "class_id": 86268,
      "class_name": "chemistry",
      "tutor_name": "Edmingle Admin",
      "total_classes": 0,
      "present": 0,
      "absent": 0,
      "late": 0,
      "excused": 0,
      "start_date": 1637107200,
      "end_date": 1642118400,
      "master_batch_id": 38521,
      "master_batch_name": "Batch 2",
      "classusers_start_date": 1695168000,
      "classusers_end_date": 0,
      "batch_status": 0,
      "cu_status": 1,
      "cu_state": 1,
      "institution_bundle_id": 1515,
      "archived_at": 0,
      "bundle_id": 1369
    },
    {
      "class_id": 86269,
      "class_name": "maths",
      "tutor_name": "Edmingle Admin",
      "total_classes": 0,
      "present": 0,
      "absent": 0,
      "late": 0,
      "excused": 0,
      "start_date": 1637107200,
      "end_date": 1642118400,
      "master_batch_id": 38521,
      "master_batch_name": "Batch 2",
      "classusers_start_date": 1695168000,
      "classusers_end_date": 0,
      "batch_status": 0,
      "cu_status": 1,
      "cu_state": 1,
      "institution_bundle_id": 1515,
      "archived_at": 0,
      "bundle_id": 1369
    },
    {
      "class_id": 86270,
      "class_name": "Electrical Sem 1 - Subject 1 - College 1",
      "tutor_name": "Edmingle Admin",
      "total_classes": 0,
      "present": 0,
      "absent": 0,
      "late": 0,
      "excused": 0,
      "start_date": 1637107200,
      "end_date": 1642118400,
      "master_batch_id": 38521,
      "master_batch_name": "Batch 2",
      "classusers_start_date": 1695168000,
      "classusers_end_date": 0,
      "batch_status": 0,
      "cu_status": 1,
      "cu_state": 1,
      "institution_bundle_id": 1515,
      "archived_at": 0,
      "bundle_id": 1369
    },
    {
      "class_id": 183739,
      "class_name": "Course re ordering",
      "tutor_name": "Edmingle Admin",
      "total_classes": 0,
      "present": 0,
      "absent": 0,
      "late": 0,
      "excused": 0,
      "start_date": 0,
      "end_date": 0,
      "master_batch_id": 64440,
      "master_batch_name": "Course re ordering",
      "classusers_start_date": 1689638400,
      "classusers_end_date": 0,
      "batch_status": 0,
      "cu_status": 2,
      "cu_state": 1,
      "institution_bundle_id": 45082,
      "archived_at": 0,
      "bundle_id": 24401
    }
  ]
}

Access: Institute admins, plus custom roles that can view learners.

Query parameters
user_idintegerrequired
Learner's user ID.
1 returns every column the query reads (adds institution_bundle_id and bundle_id). Leave it out for the standard fields.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
classesobject[]
Show child attributesHide child attributes
Example: 10383
Example: 1st Course
Example: Edmingle Admin
Sessions held so far, not counting cancelled ones
Example: 3
Example: 0
Example: 0
Example: 0
Example: 0
Example: 1676332800
Batch dates, Unix timestamps
Example: 1676332800
Example: 4499
Example: Chemistry Crash Courses
Example: 1689724800
Learner's own access dates, 0 if open
Example: 0
Example: 0
Example: 2
Example: 1
Example: 2213
Example: 0
Example: 1980

Notes: Only classes in organizations you belong to are included; resource-only courses are skipped. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI