Masterbatch List
Lists an organization's active batches that are open for sale, with course, tutor, dates and price. Use it to show upcoming batches on a public website.
GET
/website/batches/publicMasterbatch List
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/website/batches/public?institution_id=<institutionId>&organization_id=<organizationId>&get_course_tags=0&bundle_id=25&get_image_urls=1'{
"code": 200,
"message": "Success",
"courses": [
{
"master_batch_id": 722,
"master_batch_name": "Test Total Classes",
"start_date": 1556409600,
"end_date": "08 Jun 2019",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 15,
"tutor_name": "Saurav Shandilya",
"course_start_date": 1556409600,
"course_end_date": 1559952000,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 722,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
},
{
"master_batch_id": 1697,
"master_batch_name": "merge batch 1",
"start_date": 1684108800,
"end_date": "31 May 2023",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 1,
"tutor_name": " Gauravedupanion Kapoor ",
"course_start_date": 1684108800,
"course_end_date": 1685491200,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 1697,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
},
{
"master_batch_id": 1698,
"master_batch_name": "merge batch 2",
"start_date": 1684108800,
"end_date": "31 May 2023",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 15,
"tutor_name": "Saurav Shandilya",
"course_start_date": 1684108800,
"course_end_date": 1685491200,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 1698,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
},
{
"master_batch_id": 1727,
"master_batch_name": "New Batch 1",
"start_date": 1690416000,
"end_date": "29 Jul 2023",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 21,
"tutor_name": "Meghnahp",
"course_start_date": 1690416000,
"course_end_date": 1690588800,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 1727,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
},
{
"master_batch_id": 2257,
"master_batch_name": "WOOLF BATCH",
"start_date": 1695254400,
"end_date": "01 Oct 2023",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 27,
"tutor_name": "School Demo",
"course_start_date": 1695254400,
"course_end_date": 1696118400,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 2257,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
},
{
"master_batch_id": 2272,
"master_batch_name": "ard mettl test for file",
"start_date": 1696118400,
"end_date": "30 Oct 2023",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 1,
"tutor_name": " Gauravedupanion Kapoor ",
"course_start_date": 1696118400,
"course_end_date": 1698624000,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 2272,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
},
{
"master_batch_id": 2280,
"master_batch_name": "anything",
"start_date": 1696982400,
"end_date": "01 Nov 2023",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 77730,
"tutor_name": "POLY User",
"course_start_date": 1696982400,
"course_end_date": 1698796800,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 2280,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
},
{
"master_batch_id": 2282,
"master_batch_name": "test class mail reminder",
"start_date": 1697068800,
"end_date": "01 Nov 2023",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 27,
"tutor_name": "School Demo",
"course_start_date": 1697068800,
"course_end_date": 1698796800,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 2282,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
},
{
"master_batch_id": 2297,
"master_batch_name": "Batch1",
"start_date": 1704067200,
"end_date": "31 Jan 2024",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 1,
"tutor_name": " Gauravedupanion Kapoor ",
"course_start_date": 1704067200,
"course_end_date": 1706659200,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 2297,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
},
{
"master_batch_id": 2298,
"master_batch_name": "Batch2",
"start_date": 1704067200,
"end_date": "31 Jan 2024",
"bundle_id": 25,
"bundle_name": "IBPS Clerk Mains Test Series",
"pretty_url": "hemalbuha-636",
"tutor_id": 1,
"tutor_name": " Gauravedupanion Kapoor ",
"course_start_date": 1704067200,
"course_end_date": 1706659200,
"short_description": "",
"institution_bundle_id": 636,
"tags": [],
"master_batch_pricing": {
"master_batch_id": 2298,
"bundle_id": 25,
"organization_id": 2,
"currency_id": 1,
"amount": null,
"striked_amount": null,
"template_id": null,
"recurring_id": null,
"recurring_type": null,
"recurring_value": null,
"institution_bundle_id": 636
},
"bundle_img_url": "https://d3j00dvqloea7o.cloudfront.net/User(1)/CourseBundles(25)/117132-sample-clouds-400x300.jpg",
"master_batch_tags": []
}
]
}Access: Public, no API key.
Query parameters
Your institute ID. Without it nothing is returned.
Organization (branch) whose batches to list. Without it nothing is returned.
bundle_idinteger
Only batches of this course.
master_batch_idsstring
Comma-separated batch IDs to return.
start_dateUnix timestamp
With
end_date: only batches starting in this range.end_dateUnix timestamp
With
start_date: only batches starting in this range.categories_idsstring
Comma-separated category IDs. Only batches of courses in these categories.
get_only_priced_batchesinteger
1 leaves out batches with no price set.get_course_tagsinteger
1 (default) adds each course's tags. 0 skips them.get_image_urlsinteger
1 fills bundle_img_url. Default 0 (empty).get_promocodesinteger
1 adds promo_codes, the active promo codes for these courses.Response
codeinteger
Example:
200messagestring
Example:
Successcoursesobject[]
Show child attributesHide child attributes
courses.master_batch_idinteger
Example:
722Example:
Test Total Classescourses.start_dateinteger
Example:
1556409600courses.end_datestring
Example:
08 Jun 2019courses.bundle_idinteger
Example:
25courses.bundle_namestring
Example:
IBPS Clerk Mains Test Seriescourses.tutor_idinteger
Example:
15courses.tutor_namestring
Example:
Saurav Shandilyacourses.course_start_dateinteger
Example:
1556409600courses.course_end_dateinteger
Example:
1559952000Example:
636courses.tagsarray
currency_id, amount, striked_amount, template_id, recurring_id, recurring_type, recurring_value, organization_id, institution_bundle_idShow child attributesHide child attributes
Example:
722Example:
25Example:
2Example:
1Example:
636courses.bundle_img_urlstring
Batch custom fields marked as tags
Notes: Only active (not archived) batches are listed. In the example, end_date comes back as a formatted date ("08 Jun 2019") while course_end_date is a Unix timestamp. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.