Fetch Learning Plans
This API fetches a list of all the learning plans in the organization.
Request URL:
https://people.zoho.com/api/v1/learning-plans
Possible Operation Types:
READ - Only to read data
Request Parameters
Parameters | Values Allowed | Default Value | Description | Mandatory |
limit | Int | 1 | no. of learning plans to be fetched | No |
startIndex | Integer | 1 | 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
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?startIndex=0&limit=50";
Request req = new Request.Builder()
.url(url)
.get()
.addHeader("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
.build();
try (Response res = client.newCall(req).execute()) {
System.out.println(res.body().string());
}
}
}
Copiedconst url = "https://people.zoho.com/api/v1/learning-plans?startIndex=0&limit=50";
fetch(url, {
method: "GET",
headers: { Authorization: "Zoho-oauthtoken YOUR_ACCESS_TOKEN" }
})
.then(r => r.json())
.then(data => console.log(data))
.catch(err => console.error(err));
Copiedcurl -X GET "https://people.zoho.com/api/v1/learning-plans?startIndex=0&limit=50" \
-H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN"
Copiedurl = "https://people.zoho.com/api/v1/learning-plans?startIndex=0&limit=50";
headers = map();
headers.put("Authorization","Zoho-oauthtoken YOUR_ACCESS_TOKEN");
resp = getUrl(url, headers);
info resp;
Copiedimport requests
url = "https://people.zoho.com/api/v1/learning-plans"
params = {"startIndex": 0, "limit": 50}
headers = {"Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN"}
r = requests.get(url, params=params, headers=headers)
print(r.json())
HEADER
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
SAMPLE REQUEST
Copiedhttps://people.zoho.com/api/v1/learning-plans
SAMPLE RESPONSE
Copied{
"message": "Learning plan details fetched successfully",
"learning-plans": [
{
"planId": "100002000000046167",
"planInfo": {
"duration": "30",
"publishState": "1",
"planImageInfo": {
"isSystem": true,
"image": "23",
"imageUrl": "/newhr/images/lmsbg/cat23.png"
},
"activeCourseCount": "2",
"planName": "L1",
"createdTime": "1755596717804",
"planId": "100002000000046167",
"disabled": "false",
"durationType": "0",
"mandatoryCourseCount": "1",
"isPlanOwner": true
}
}
],
"status": 200
}