Get custom portal users
The purpose of this API is to get the users in a custom portal.
| Request URL: | https://learn.zoho.com/learn/api/v1/portal/<networkurl>/customportal/<customportalId>/users |
| OAuth Scope: | ZohoLearn.customportaluser.READ |
| Request Method: | GET |
Sample Response :
Copied{
"STATUS": "OK",
"clients": [
{
"role": "CLIENT",
"colorIndex": "0",
"emailId": "user1@zylker.com",
"isClient": "true",
"clientPortalName": "Zylker Partner Portal",
"clientPortalId": "6342496000000045001",
"type": "CLIENT",
"learnerCourseProgress": "0.0",
"memberSince": {
"date": "19 Apr 2023",
"time": "11:46 PM"
},
"imageURL": "\/_lms\/api\/portal\/zylker-network\/profileimage\/10056528043",
"name": "user1",
"id": "10056528043",
"learnerCourseStatus": "YET_TO_START",
"status": "ACTIVE"
},
{
"role": "CLIENT",
"colorIndex": "0",
"emailId": "user2@zylker.com",
"isClient": "true",
"clientPortalName": "Zylker Partner Portal",
"clientPortalId": "6342496000000045001",
"type": "CLIENT",
"learnerCourseProgress": "0.0",
"memberSince": {
"date": "19 Apr 2023",
"time": "11:41 PM"
},
"imageURL": "\/_lms\/api\/portal\/zylker-network\/profileimage\/10056529205",
"name": "User 2",
"id": "10056529205",
"learnerCourseStatus": "YET_TO_START",
"status": "ACTIVE"
}
]
}Show full
Show less