Fetch Single Batch API | LMS

Fetch Course Batch List API

This API is used for fetching the list of batches in a course in LMS.

Request URL: (Blended Learning Course)

https://people.zoho.com/api/v1/courses/<courseId>/batches

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.READ

Possible Operation Types:

ALL - Complete access to data
READ - Only to fetch data

Method:

GET

Request Parameters

Parameters	Values Allowed	Default Value	Description
startIndex	<integer>	0	Specify from which record the response should be fetched

Note: Upto 25 records can be fetched in a single call.

Request

Copiedhttps://people.zoho.com/api/v1/courses/219225000000645203/batches

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Response

Copied{
    "batches": [
        {
            "learnersCount": 0,
            "startDateAsDisplayString": "22-Dec-2021",
            "endDateAsDisplayString": "27-Jan-2022",
            "name": "Batch One",
            "schedulerId": 0,
            "minimumCapacity": 10,
            "cancelBatchWhenMinimumCapacityIsNotMet": false,
            "maximumCapacity": 40,
            "batchId": "219225000000645215",
            "courseId": "219225000000645203",
            "publishStatus": "published",
            "allowWaitlisting": false
        }
    ],
    "code": "200",