Get Users of a User Type
Purpose
To get the list of users available in a user type of a portal.
Request Details
Request URL
{api-domain}/crm/{version}/settings/portals/{portal_name}/user_type/{user_type_id}/users
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.settings.clientportal.ALL
(or)
Scope=ZohoCRM.settings.clientportal.READ
Parameters
- typestring, mandatory
The type of user such as AllUsers, AllActiveUsers, ActiveUsers, DeactiveUsers, NotConfirmedUsers, ConfirmedUsers, and ActiveConfirmedUsers.
- filterJSON object, encoded, optional
To filter based on the value disabled on updation of email of the status_reason__s field in the Users module. The allowed comparators areequal and not_equal. Note that you must encode this JSON oject.
Sample Request
Copied
Response JSON
- personality_id
The ID of the module for which the portal was created.
- confirm
Represents whether the user is confirmed or not.
- status_reason__s
The reason why the user is disabled.
- invited_time
Date and time in the ISO8601 format on which the user was invited to the portal.
- module
The API name of the module for which the user type was created.
- name
The full name of the contact you want to fetch the user type of.
- active
Represents whether the user type is active or not.
- email
The email ID of the contact of that user type.
Possible Errors
- PATTERN_NOT_MATCHEDHTTP 400
The value for the "type" parameter is invalid.
Resolution: The "type" parameter can only take one of the following values:
AllUsers, AllActiveUsers, ActiveUsers, DeactiveUsers, NotConfirmedUsers, ConfirmedUsers, and ActiveConfirmedUsers. - NO_PERMISSIONHTTP 403
You do not have permission to the portal.
Resolutions Contact your administrator.
Sample Response
Copied