Get Users of a User Type

Purpose

To get the list of users available in a user type of a portal.

Endpoints

GET /crm/{version}/settings/portals/{portal_name}/user_type/{user_type_id}/users

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

Copiedcurl "https://www.zohoapis.com/crm/v6/settings/portals/PortalsAPItest200/user_type/3652397000006231003/users?type=NotConfirmedUsers&filters=%5B%7B%22field%22%3A%22status_reason__s%22%2C%22value%22%3A%22disabled%20on%20updation%20of%20email%22%2C%22comparator%22%3A%22not_equal%22%7D%5D"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"

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{
    "users": [
        {
            "personality_id": "3652397000009883004",
            "confirm": false,
            "status_reason__s": null,
            "invited_time": "2022-12-07T16:41:05+05:30",
            "module": "Contacts",
            "name": "Prince Brian",
            "active": true,
            "email": "p.brian@zylker.com"
        },
        {
            "personality_id": "3652397000007603014",
            "confirm": false,
            "status_reason__s": null,
            "invited_time": "2022-12-07T16:41:04+05:30",
            "module": "Contacts",
            "name": "Paul Daly",
            "active": true,
            "email": "p.daly@zylker.com"
        },
        {
            "personality_id": "3652397000000649013",
            "confirm": false,
            "status_reason__s": null,
            "invited_time": "2022-12-07T16:41:04+05:30",
            "module": "Contacts",
            "name": "Patricia Boyle",
            "active": true,
            "email": "p.boyle@abc.com"
        },
        {
            "personality_id": "3652397000000269089",
            "confirm": false,
            "status_reason__s": null,
            "invited_time": "2021-11-25T16:14:56+05:30",
            "module": "Contacts",
            "name": "Carissa Batman",
            "active": true,
            "email": "carissa-batman@yahoo.com"
        }
    ],
    "info": {
        "per_page": 200,
        "total_count": 4,
        "count": 4,
        "page": 1,
        "more_records": false
    }
}