Docs home

Get Batch

Returns one batch with its classes (subjects), tutors, dates, session counts and enrolment counts. Use it to read a batch before editing it with "Edit Batch".

GET/masterbatch/{master_batch_id}
Get Batch
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/masterbatch/{master_batch_id}' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "class": {
    "courses_array": [
      {
        "class_id": 4402,
        "tutor_id": 1,
        "tutor_name": " Gauravedupanion Kapoor ",
        "course_id": 23,
        "batch_name": "Physics for IIT JEE - Mechanics Module",
        "is_live": 0,
        "zoom_room_waiting": 0,
        "batch_class_count": null,
        "completed": 0,
        "total_classes": 0,
        "cancelled": 0,
        "display_index": 3807,
        "num_users": 0,
        "associated_masterbatches": [
          2341
        ],
        "common_class": 0,
        "virtual_class_type": 0,
        "external_class_link": "",
        "is_time_restricted": 0
      },
      {
        "class_id": 4403,
        "tutor_id": 1,
        "tutor_name": " Gauravedupanion Kapoor ",
        "course_id": 24,
        "batch_name": "Chemistry for IIT JEE - Organic Chemistry",
        "is_live": 0,
        "zoom_room_waiting": 0,
        "batch_class_count": null,
        "completed": 0,
        "total_classes": 0,
        "cancelled": 0,
        "display_index": 3808,
        "num_users": 0,
        "associated_masterbatches": [
          2341
        ],
        "common_class": 0,
        "virtual_class_type": 0,
        "external_class_link": "",
        "is_time_restricted": 0
      },
      {
        "class_id": 4404,
        "tutor_id": 1,
        "tutor_name": " Gauravedupanion Kapoor ",
        "course_id": 236,
        "batch_name": "Mathematics for IIT JAM - Algebra & Calculus",
        "is_live": 0,
        "zoom_room_waiting": 0,
        "batch_class_count": null,
        "completed": 0,
        "total_classes": 0,
        "cancelled": 0,
        "display_index": 3809,
        "num_users": 0,
        "associated_masterbatches": [
          2341
        ],
        "common_class": 0,
        "virtual_class_type": 0,
        "external_class_link": "",
        "is_time_restricted": 0
      }
    ],
    "class_id": 2341,
    "class_name": "IIT JEE Foundation Batch - March 2026",
    "tutor_id": 165264,
    "tutor_name": "huhuhu",
    "bundle_id": 1287,
    "start_date": "09 Mar 2026",
    "end_date": "30 Jun 2026",
    "individual_batch_attendance": 1,
    "organization_id": 2,
    "completed": 0,
    "total_classes": 0,
    "cancelled": 0,
    "bundle_name": "ARD JEE Course",
    "external_class_link": "",
    "num_registrations": 0,
    "admitted_students": 0,
    "archived": 0
  },
  "tags": [],
  "community": [
    {
      "community_image_url": null
    }
  ]
}

Access: Institute admins, tutors and custom roles with batch access, for batches in their organizations. Tutors who do not manage the batch only see their own classes in it.

Path parameters
master_batch_idintegerrequired
The batch ID, as the last URL segment.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
classobject
Show child attributesHide child attributes
Show child attributesHide child attributes
Batch ID
Example: 4402
Batch manager
Example: Gauravedupanion Kapoor
Class name
Example: Physics for IIT JEE - Mechanics Module
Session counts
Example: 0
Batch IDs sharing this class
1 if shared
Example: 0
Batch ID
Example: 2341
Batch name
Example: IIT JEE Foundation Batch - March 2026
Example: 165264
Batch manager
Example: huhuhu
Example: 1287
Example: 09 Mar 2026
Formatted like 18 Aug 2021, or null
Example: 30 Jun 2026
Example: 2
Example: 0
Example: 0
Session counts
Example: 0
Example: ARD JEE Course
Example: 0
Example: 0
0 active, 1 archived, 3 completed
Example: 0
tagsarray
communityobject[]
Show child attributesHide child attributes

Notes: A batch outside your organizations returns "Invalid Batch ID". Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI