Single Course - All Learner Progress

This API Provides the progress of all the users enrolled in a particular course.

Request URL:

https://people.zoho.com/api/v1/courses/<courseId>/(batches/<batchId>/)course-progress

Possible Operation Types:

READ - Only to read data

Request Parameters

Parameters	Values Allowed	Default Value	Description	Mandatory
startIndex	Integer	0	starting index	No

View complete list of LMS API error codes

Threshold Limit: 30 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

REQUESTS

Java JavaScript Curl Deluge Python

Copiedimport okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

public class Main {
    public static void main(String[] args) throws Exception {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/course-progress")
            .get()
            .addHeader("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .build();

        Response response = client.newCall(request).execute();
        System.out.println(response.body().string());
    }
}

Copiedfetch("https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/course-progress", {
  method: "GET",
  headers: {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error("Error:", error));

Copiedcurl -X GET "https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/course-progress" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"

Copiedurl = "https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/course-progress";
headers = map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
response = getUrl(url, headers);
info response;

Copiedimport requests

url = "https://people.zoho.com/api/v1/courses/100002000000039001/batches/100002000000041383/course-progress"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

HEADER

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

SAMPLE REQUEST

Copiedhttps://people.zoho.com/api/v1/courses/100002000000043241/batches/100002000000044056/learners/100002000000040488/course-progress

SAMPLE RESPONSE (Blended Learning)

Copied{
  "courseProgress": [
    {
      "batchName": "Batch 1",
      "courseType": "Blended learning",
      "totalEntitiesCount": 4,
      "enrolledDate": "03-Aug-2023",
      "learnerName": "Harvey spector",
      "batchId": 100004000000045013,
      "type": 2,
      "completedIn": "",
      "learnerImageURL": "https://contacts.csez.zohocorpin.com/file?ID=16619869&fs=thumb",
      "completedEntitiesCount": 1,
      "completionPercentage": 25,
      "courseName": "Blended Learning7!@#$%^&()--+=;;:\"',.?/|\\{}[]",
      "managerEvaluationTotalMarks": "",
      "learnerId": "100004000000036860",
      "managerEvaluationMarks": "",
      "completionDate": "",
      "completionStatus": "In progress",
      "courseId": 100004000000045001
    }
  ],
  "code": 200,
  "message": "success",
  "hasMoreRecords": false
}

SAMPLE RESPONSE (SELF PACED)

Copied{
  "courseProgress": [
    {
      "batchName": "",
      "courseType": "Self paced learning",
      "totalEntitiesCount": 2,
      "enrolledDate": "01-Aug-2023",
      "learnerName": "Harvey spector",
      "batchId": "",
      "type": 1,
      "completedIn": "",
      "learnerImageURL": "https://contacts.csez.zohocorpin.com/file?ID=16624880&fs=thumb",
      "completedEntitiesCount": 0,
      "completionPercentage": 0,
      "courseName": "Hello",
      "managerEvaluationTotalMarks": "",
      "learnerId": "100004000000042001",
      "managerEvaluationMarks": "",
      "completionDate": "",
      "completionStatus": "In progress",
      "courseId": 100004000000036814
    },
    {
      "batchName": "",
      "courseType": "Self paced learning",
      "totalEntitiesCount": 2,
      "enrolledDate": "01-Aug-2023",
      "learnerName": "Harvey spector",
      "batchId": "",
      "type": 1,
      "completedIn": "",
      "learnerImageURL": "https://contacts.csez.zohocorpin.com/file?ID=16619869&fs=thumb",
      "completedEntitiesCount": 0,
      "completionPercentage": 0,
      "courseName": "Hello",
      "managerEvaluationTotalMarks": "",
      "learnerId": "100004000000036860",
      "managerEvaluationMarks": "",
      "completionDate": "",
      "completionStatus": "In progress",
      "courseId": 100004000000036814
    }
  ],
  "code": 200,
  "message": "success",
  "hasMoreRecords": false
}