Docs home

Get Batch Details and Class IDs by Batch IDs

Returns one of the learner's enrolled batches: each class (subject) in it with the learner's progress and rank, plus batch and course details. Use it to build a learner's "my course" page.

GET/student/masterbatches/classes/{master_batch_id}
Get Batch Details and Class IDs by Batch IDs
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/student/masterbatches/classes/{master_batch_id}?show_overview=1' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "courses": [
    {
      "archived": 0,
      "category": 3,
      "class_id": 182884,
      "class_name": "sample",
      "course_id": 40450,
      "course_name": "sample",
      "class_end_date": null,
      "organization_id": 212,
      "resource_only_course": 0,
      "class_start_date": null,
      "status": "live",
      "tutor_id": 3846680,
      "tutor_name": "Edmingle Admin",
      "tutor_username": "demoadmin",
      "img_url": "",
      "is_time_restricted": 0,
      "is_woolf_accredited": 0,
      "name": "sample",
      "num_of_sections": "",
      "total_assignments": "",
      "assignment_completed": "",
      "stats": {
        "class_id": "182884",
        "class_name": "sample",
        "course_num_exercises": "4",
        "course_num_quizzes": "2",
        "course_num_assignments": "2",
        "course_num_materials": "27",
        "course_num_sections": "4",
        "total_items": "35",
        "user_uattempts": "0",
        "user_passed": "0",
        "user_usubmissions": "0",
        "user_mat_uviews": "2",
        "user_uattempts_quiz": "0",
        "user_passed_quiz": "0",
        "student_name": "Asit Update",
        "student_username": "Asit9679054",
        "num_students": "21",
        "c_attempts": "26",
        "user_attempts": "0",
        "user_perfect": "0",
        "avg_grade": 0,
        "class_progress": 6,
        "rank": "7",
        "rank_ties": 0
      }
    }
  ],
  "code": 200,
  "message": "Success",
  "master_batch_details": {
    "master_batch_name": "sample",
    "bundle_name": "2026 Welcome to India Course",
    "is_woolf_accredited": 0,
    "master_batch_id": 64025,
    "mb_start_date": null,
    "mb_end_date": null,
    "mb_tutor_id": 3846680,
    "mb_tutor_name": "Edmingle Admin",
    "mb_tutor_username": "demoadmin",
    "free_preview_allowed": 0,
    "payment_id": 1819581,
    "institution_bundle_id": 44840,
    "organization_id": 212,
    "allow_student_unenrolling": 0,
    "allow_curriculum_access_after_completed": 0,
    "allow_student_mark_batch_completed": 0,
    "mb_status": 0,
    "accepted": 1,
    "status": 1,
    "bundle_id": 24162,
    "pretty_name": "sample",
    "tutor_img": "https://dme2wmiz2suov.cloudfront.net/User(3846680)/3923130-127021-images.png",
    "mb_tutor_about": "<p>Admin account for Instructor's Profile</p>\n",
    "show_completion_nudges": 0,
    "batch_community_id": "0",
    "student_community_status": "0",
    "enrollment_expiration_date": 0,
    "is_prerequisite": 0,
    "is_ai_embedding_allowed": 0,
    "bundle_image_url": "https://dme2wmiz2suov.cloudfront.net/User(53044146)/CourseBundles(24162)/3684846-124855-Gspace.png",
    "progress": 6,
    "num_materials": 27,
    "num_exercises": 4,
    "user_uviews": 2,
    "user_passed": 0,
    "user_uattempts": 0,
    "avg_grade": 0,
    "avg_rank": 1,
    "bundle_overview": "<p style=\"text-align: left;\"><b style=\"color: #333333;\">The following chapters will be covered in this course :</b></p><p style=\"text-align: left;\"><span style=\"color: #333333;\"><b># Organic Chemistry </b></span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">1) </span><span style=\"background-color: #ffff00;\">General Organic Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">2) </span><span style=\"background-color: #ffff00;\">Aromaticity </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">3) </span><span style=\"background-color: #ffff00;\">Stereochemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">4) </span><span style=\"background-color: #ffff00;\">Reaction Mechanism (Part-1) </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">5) </span><span style=\"background-color: #ffff00;\">Reaction Intermediates </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">6) </span><span style=\"background-color: #ffff00;\">Reagents </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">7) Pericyclic Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">8) Photochemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">9) </span><span style=\"background-color: #ffff00;\">Carbonyl Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">10) </span><span style=\"background-color: #ffff00;\">Named Reactions </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">11) </span><span style=\"background-color: #ffff00;\">Reaction Mechanism (Part-2) </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">12) Organic Spectroscopy </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">13) Heterocyclic Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">14) Biomolecules </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\"><b># Physical Chemistry </b></span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">1) </span><span style=\"background-color: #ffff00;\">General Physical Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">2) </span><span style=\"background-color: #ffff00;\">Chemical Kinetics </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">3) </span><span style=\"background-color: #ffff00;\">Quantum Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">4) </span><span style=\"background-color: #ffff00;\">Surface Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">5) </span><span style=\"background-color: #ffff00;\">Polymer Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">6) Thermodynamics (Chemical + Stat.) </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">7) </span><span style=\"background-color: #ffff00;\">Group Theory </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">8) </span><span style=\"background-color: #ffff00;\">Electrochemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">9) Molecular Spectroscopy </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">10) Solid State </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">11) Phase Equilibrium </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">12) Data Analysis </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\"><b># Inorganic Chemistry </b></span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">1) </span><span style=\"background-color: #ffff00;\">General Inorganic Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">2) </span><span style=\"background-color: #ffff00;\">Chemical Bonding </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">3) </span><span style=\"background-color: #ffff00;\">Coordination Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">4) f-Block </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">5) </span><span style=\"background-color: #ffff00;\">Organometallic Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">6) Bioinorganic Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">7) Inorganic Spectroscopy </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">8) Nuclear Chemistry </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">9) Acids and Bases </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">10) Main Block </span></p><p style=\"text-align: left;\"><span style=\"color: #333333;\">11) Analytical Chemistry </span></p><p style=\"text-align: left;\"><span style=\"background-color: #ffff00;\">Yellow Highlighted Chapters will be covered by Jyoti Ma&rsquo;am</span></p><p><span style=\"color: #333333; font-weight: bold;\">&nbsp;</span></p><p><span style=\"color: #333333; font-weight: bold;\">*You can access the videos through J Chemistry App only*</span></p>\n"
  },
  "masterbatch_pending": [],
  "free_preview_masterbatch": [],
  "student_last_view": [
    {
      "section_id": 178109,
      "resource_id": "622957",
      "resource_type": 4,
      "class_id": 182884
    }
  ],
  "last_viewed_class_id": "182884"
}

Access: Learners, for batches they are enrolled in (or previewing).

Path parameters
master_batch_idintegerrequired
The batch ID, as the last URL segment.
Query parameters
get_tagsinteger
1 adds tags, the course's tag categories.
1 adds master_batch_details.bundle_overview (HTML).
Response200application/json
coursesobject[]
One entry per active or completed class in the batch
Show child attributesHide child attributes
Example: 0
Example: 3
Example: 182884
Example: sample
Example: 40450
Curriculum
Example: sample
Unix timestamps or null
Example: 212
draft/live
Example: live
Example: 3846680
Example: Edmingle Admin
Example: demoadmin
Example: sample
Show child attributesHide child attributes
Example: 182884
Example: sample
Example: 35
Example: Asit Update
Example: Asit9679054
Example: 26
Example: 0
Percent
Example: 6
Example: 7
Example: 0
codeinteger
Example: 200
messagestring
Example: Success
Show child attributesHide child attributes
Example: 2026 Welcome to India Course
Example: 3846680
Example: Edmingle Admin
Example: 1819581
draft/live
Example: 1
Example: 24162
Example: <p>Admin account for Instructor's Profile</p>
Percent
Example: 6
Show child attributesHide child attributes
Example: 178109
Example: 622957
Example: 182884
Example: 182884

Notes: If the learner has no access to the batch, the call fails with "You do not have access to this course or batch.". Calling it also marks the batch as the learner's most recently opened one, which moves it to the top of "Student Enroll Batches". Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI