Get Shared Users List API
This API is used to get course shared users list in LMS.
Request URL:
https://people.zoho.com/api/v1/courses/<courseId>/share
Scope:
ZOHOPEOPLE.training.ALL
OR
ZOHOPEOPLE.training.READ
Possible Operation Types:
ALL - Complete access to data
READ - Only to read data
Method:
GET
Request Parameters
| Parameters | Values Allowed | Default Value | Description |
| startIndex | <integer> | 0 | Specify from which record the response should be fetched |
Error Codes and Descriptions
| Status Codes | Description |
|---|---|
| 400 | Invalid parameter value/input parameter missing |
| 403 | Sorry! You are not authorized to do this operation |
| 404 | Not found |
| 422 | Maximum limit exceeded |
| 500 | Sorry! Server error occured |
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.
Sample Request
Copiedimport okhttp3.*;
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/588882000000289003/share?startIndex=1")
.get()
.addHeader("Cookie", "CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****")
.build();
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
}
}Copiedfetch("https://people.zoho.com/api/v1/courses/588882000000289003/share?startIndex=1", {
method: "GET",
headers: {
"Cookie": "CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****"
}
})
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.error(error));Copiedcurl --location --request GET 'https://people.zoho.com/api/v1/courses/588882000000289003/share?startIndex=1' \
--header 'Cookie: CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****'Copiedresponse = invokeurl
[
url: "https://people.zoho.com/api/v1/courses/588882000000289003/share?startIndex=1"
type: GET
headers: {
"Cookie": "CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****"
}
];
info response;Copiedimport requests
url = "https://people.zoho.com/api/v1/courses/588882000000289003/share?startIndex=1"
headers = {
"Cookie": "CSRF_TOKEN=****; _zcsr_tmp=****; _zpsid=****; zalb_c7cb34e6ac=****"
}
response = requests.get(url, headers=headers)
print(response.text)Show full
Show less
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxfSample Response
Copied{
"sharedUsers": [
{
"erecno": "219225000000185023",
"displayName": "Henry",
"employeeId": "1001",
"emailId": "henry@zohotest.com",
"displayPictureURL": "https://contacts.zoho.com/file?ID=705822094&fs=thumb"
}
],
"code": "200",
"message": "success",
"hasMoreRecords": false
}