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/masterbatchList 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.
bundle_idsstring
Comma-separated course IDs. Overrides
bundle_id.statusinteger
0 active, 1 archived, 3 completed. Leave it out (or -1) to get all.product_typeinteger
1 Course (default), 2 Event, 3 Membership, 4 Mentorship, 5 eBook, 6 Test series, 7 Playlist.batch_periodinteger
1 past (ended before today), 2 ongoing, 3 upcoming or without dates.organization_idinteger
Limit to one of your organizations. Ignored if you are not a member of it. Default: all your organizations.
searchstring
Matches part of the batch name.
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.get_batch_custom_fieldsinteger
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.
Response
codeinteger
Example:
200messagestring
Example:
Successcoursesobject[]
Show child attributesHide child attributes
courses.bundle_idinteger
Example:
29courses.bundle_namestring
Example:
Master Package JEEcourses.batchobject[]
Show child attributesHide child attributes
Unix timestamps,
null if not setExample:
0courses.batch.tutor_idinteger
Example:
27courses.batch.tutor_namestring
Example:
School Democourses.batch.online_onlyinteger
Example:
1courses.batch.classesinteger[][]
courses.batch.progressstring[]
Example:
18Example:
0Example:
2courses.batch.total_classesinteger
Example:
0Example:
0Example:
0courses.online_onlyinteger
Example:
1Notes: 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.