Docs home

List All Batch

Lists batches grouped by course (bundle), with each batch's classes (subjects), tutor, dates, enrolment counts and class progress. Use it to sync your batch list, or to find the batches of one course.

GET/short/masterbatch
List All Batch
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/short/masterbatch?status=0&page=1&per_page=100&organization_id=<organizationId>&bundle_id=<bundleId>' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "courses": [
    {
      "bundle_id": 29,
      "bundle_name": "Master Package JEE",
      "batch": [
        {
          "class_id": 746,
          "class_name": "Master Package JEE",
          "start_date": null,
          "end_date": null,
          "individual_batch_attendance": 0,
          "tutor_id": 27,
          "tutor_name": "School Demo",
          "online_only": 1,
          "classes": [
            [
              986,
              2,
              "0",
              0,
              "School Demo",
              "Physics XI + IIT JEE Mains",
              18,
              0,
              [
                null,
                null,
                [],
                0
              ],
              1,
              27,
              33,
              0,
              0,
              0,
              0,
              0
            ],
            [
              987,
              2,
              "0",
              0,
              "School Demo",
              "Chemistry IIT JEE Mains",
              18,
              0,
              [
                null,
                null,
                [],
                0
              ],
              1,
              27,
              175,
              0,
              0,
              0,
              0,
              0
            ],
            [
              988,
              2,
              "0",
              0,
              "School Demo",
              "Maths IIT JEE Mains",
              18,
              0,
              [
                null,
                null,
                [],
                0
              ],
              1,
              27,
              174,
              0,
              0,
              0,
              0,
              0
            ],
            [
              989,
              2,
              "0",
              0,
              "School Demo",
              "Physics XI + IIT JEE Mains",
              18,
              0,
              [
                null,
                null,
                [],
                0
              ],
              1,
              27,
              33,
              0,
              0,
              0,
              0,
              0
            ],
            [
              990,
              2,
              "0",
              0,
              "School Demo",
              "Chemistry IIT JEE Mains",
              18,
              0,
              [
                null,
                null,
                [],
                0
              ],
              1,
              27,
              175,
              0,
              0,
              0,
              0,
              0
            ],
            [
              991,
              2,
              "0",
              0,
              "School Demo",
              "Maths IIT JEE Mains",
              18,
              0,
              [
                null,
                null,
                [],
                0
              ],
              1,
              27,
              174,
              0,
              0,
              0,
              0,
              0
            ],
            [
              992,
              2,
              "0",
              0,
              "School Demo",
              "Physics XI + IIT JEE Mains",
              18,
              0,
              [
                null,
                null,
                [],
                0
              ],
              1,
              27,
              33,
              0,
              0,
              0,
              0,
              0
            ],
            [
              993,
              2,
              "0",
              0,
              "School Demo",
              "Chemistry IIT JEE Mains",
              18,
              0,
              [
                null,
                null,
                [],
                0
              ],
              1,
              27,
              175,
              0,
              0,
              0,
              0,
              0
            ],
            [
              994,
              2,
              "0",
              0,
              "School Demo",
              "Maths IIT JEE Mains",
              18,
              0,
              [
                null,
                null,
                [],
                0
              ],
              1,
              27,
              174,
              0,
              0,
              0,
              0,
              0
            ]
          ],
          "attendance_progress_arr": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ],
          "progress": [
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0",
            "0"
          ],
          "organization_id": 18,
          "registered_students": 0,
          "admitted_students": 2,
          "total_classes": 0,
          "completed_classes": 0,
          "cancelled_classes": 0,
          "attendance_progress": 0
        },
        {
          "class_id": 1055,
          "class_name": "Master Package JEE",
          "start_date": 1599264000,
          "end_date": 1599955200,
          "individual_batch_attendance": 0,
          "tutor_id": 1,
          "tutor_name": " Gaurav Kapoor",
          "online_only": 1,
          "classes": [
            [
              1725,
              15,
              "0",
              5,
              " Gaurav Kapoor",
              "Physics XI + IIT JEE Mains",
              2,
              0,
              [
                1599264000,
                1599955200,
                [
                  [
                    0,
                    480,
                    540
                  ],
                  [
                    2,
                    480,
                    540
                  ],
                  [
                    4,
                    480,
                    540
                  ],
                  [
                    5,
                    480,
                    540
                  ]
                ],
                0
              ],
              1,
              1,
              33,
              22,
              0,
              0,
              0,
              0
            ],
            [
              1726,
              15,
              "0",
              0,
              " Gaurav Kapoor",
              "Chemistry IIT JEE Mains",
              2,
              0,
              [
                1599244200,
                1599935400,
                [],
                0
              ],
              1,
              1,
              175,
              0,
              0,
              0,
              0,
              0
            ],
            [
              1727,
              15,
              "0",
              0,
              " Gaurav Kapoor",
              "Maths IIT JEE Mains",
              2,
              0,
              [
                1599244200,
                1599935400,
                [],
                0
              ],
              1,
              1,
              174,
              0,
              0,
              0,
              0,
              0
            ]
          ],
          "attendance_progress_arr": [
            22,
            0,
            0
          ],
          "progress": [
            "0",
            "0",
            "0"
          ],
          "organization_id": 2,
          "registered_students": 0,
          "admitted_students": 15,
          "total_classes": 9,
          "completed_classes": 2,
          "cancelled_classes": 0,
          "attendance_progress": 7.333333333333333
        }
      ],
      "online_only": 1
    }
  ]
}

Access: Institute admins, tutors, plus custom roles that can view batches, abandoned carts or attendance reports. Tutors and custom roles without "all batches" access only see batches they teach or created.

Query parameters
bundle_idinteger
Only batches of this course.
Comma-separated course IDs. Overrides bundle_id.
statusinteger
0 active, 1 archived, 3 completed. Leave it out (or -1) to get all.
1 Course (default), 2 Event, 3 Membership, 4 Mentorship, 5 eBook, 6 Test series, 7 Playlist.
1 past (ended before today), 2 ongoing, 3 upcoming or without dates.
Limit to one of your organizations. Ignored if you are not a member of it. Default: all your organizations.
filtersJSON string
Extra filters: class_ids (subject IDs), tutor_ids, bundle_ids (arrays of integers) and batch_period.
get_tagsinteger
1 adds each course's tags.
1 adds each batch's customfield_data.
pageinteger
Page number. Send page or per_page to paginate; otherwise all batches are returned.
per_pageinteger
Results per page. Default 50 when paginating.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
coursesobject[]
Show child attributesHide child attributes
Example: 29
Example: Master Package JEE
Show child attributesHide child attributes
The batch ID
Example: 746
Batch name
Example: Master Package JEE
Unix timestamps, null if not set
Example: 27
Example: School Demo
Example: 1
Percent of sessions held
Example: 0
Example: 1

Notes: Batches whose classes have no curriculum statistics are not returned. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI