Get list of users - Zoho Webinar
Table of Contents
Note:
- This task is applicable to all services except Zoho Creator.
- Each time the zoho.webinar.getUsersList integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
- Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.webinar.getUsersList integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script.
Overview:
This task is used to get a list of users in an organization in Zoho Webinar.
This task is based on Zoho Webinar API: List of users.
Syntax:
<variable> = zoho.webinar.getUsersList(<portal_id>, <index>, <count>, <connection>);
where:
| Params | Data type | Description |
| <variable> | KEY-VALUE | Specifies the variable that will hold the response returned by Zoho Webinar. |
| <portal_Id> | NUMBER | Specifies the unique portal identifier where the users will be fetched from.
|
| <index> | INTEGER | Specifies the pagination start index. Default: "1". |
| <count> | INTEGER | Specifies the number of users list. |
| <connection> | TEXT | Specifies the link name of the Zoho Webinar connection. Required scope for this connection: ZohoWebinar.user.READ |
Example:
response = zoho.webinar.getUsersList(99031443,1,20,"webinar");
where:
response
Is the KEY-VALUE returned by Zoho Webinar. It represents the user details.
"99031443"
Is the NUMBER of the unique portal identifier where the user details will be fetched from.
"1"
Is the INTEGER of the pagination start index. Default: "1".
"20"
Is the INTEGER of the number of users list.
"webinar"
Is the TEXT that represents the name of the connection.
Sample response
Success response
{
"representation": [
{
"userId": "640967000000027007",
"zuid": "99030795",
"role": "Administrator",
"organization": {
"orgId": "99031443",
"orgName": "sri",
"link": "/api/v2/org/99031443",
"isDefault": true
},
"firstName": "admin",
"lastName": "user",
"fullName": "asminf user",
"emailId": "admin.nm+n1@zoho.com"
}
],
"totalCount": 4,
"resourceType": "/api/v2/99031443/user"
}
"representation": [
{
"userId": "640967000000027007",
"zuid": "99030795",
"role": "Administrator",
"organization": {
"orgId": "99031443",
"orgName": "sri",
"link": "/api/v2/org/99031443",
"isDefault": true
},
"firstName": "admin",
"lastName": "user",
"fullName": "asminf user",
"emailId": "admin.nm+n1@zoho.com"
}
],
"totalCount": 4,
"resourceType": "/api/v2/99031443/user"
}
Failure response
{
"error": {
"code": 1025,
"message": "Org doesn't matches with request uri"
},
"resourceType": "/api/v2/9903143/user"
}
"error": {
"code": 1025,
"message": "Org doesn't matches with request uri"
},
"resourceType": "/api/v2/9903143/user"
}