Fetch Learning Plan's Members Details

Fetch Learning Plan's Learner Details

This API fetches the list of all learners in a particular learning plan.

Request URL:

https://people.zoho.com/api/v1/learning-plans/<planId>/learners

Possible Operation Types:

READ - Only to read data

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();

        String url = "https://people.zoho.com/api/v1/learning-plans/100002000000046167/members";

        Request request = new Request.Builder()
            .url(url)
            .get()
            .addHeader("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .build();

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

Copiedconst url = "https://people.zoho.com/api/v1/learning-plans/100002000000046167/members";

fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"
  }
})
  .then(res => res.json())
  .then(data => console.log(data))
  .catch(err => console.error("Error:", err));

Copiedcurl -X GET "https://people.zoho.com/api/v1/learning-plans/100002000000046167/members" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"

Copiedurl = "https://people.zoho.com/api/v1/learning-plans/100002000000046167/members";
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/learning-plans/100002000000046167/members"
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/learning-plans/100002000000046167/members

SAMPLE RESPONSE

Copied{
    "enrolledMembers": {
        "100002000000040623": {
            "desigName": "",
            "image": "https://contacts.csez.zohocorpin.com/file?ID=16277312&fs=thumb",
            "photoPath": "https://contacts.csez.zohocorpin.com/file?ID=16277312&fs=thumb",
            "planuserId": "100002000000046189",
            "employeeId": "0",
            "completedCourseCnt": "0",
            "userId": "100002000000040623",
            "aboutme": "",
            "modeOfJoin": "0",
            "enrollmentStatus": "1",
            "name": "Mike Ross",
            "planId": "100002000000046167",
            "userType": "1",
            "user": "100002000000040623",
            "email": "abishaik.smu+1@zohotest.com"
        }
    },
    "message": "Plan learners fetched successfully",
    "enrolledMemberCnt": 1,
    "status": 200
}