获取特定用户类型的用户
目的
获取门户中某用户类型的用户列表。
端点
- GET /settings/portals/{portal_name}/user_type/{user_type_id}/users
请求详情
请求 URL
{api-domain}/crm/{version}/settings/portals/{portal_name}/user_type/{user_type_id}/users
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.settings.clientportal.ALL
(或)
Scope=ZohoCRM.settings.clientportal.READ
参数
- type字符串,必填
用户类型,例如 所有Users、所有活跃Users、活跃Users、非活跃Users、未Confirm的Users、已Confirm的Users和活跃已Confirm的Users。
- filtersJSON 对象,编码,可选
根据 更新电子邮件时禁用 的 status_reason__s 字段在 Users 模块中进行过滤。允许的比较器是 等于 和 不等于。请注意,您必须对这个 JSON 对象进行编码。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/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"响应 JSON
- personality_id
创建门户的模块ID。
- confirm
表示用户是否已确认。
- status_reason__s
用户被禁用的原因。
- invited_time
用户被邀请到门户的日期和时间,采用ISO8601格式。
- 模块
创建用户类型的模块的API名称。
- name
您想要获取用户类型的联系人的全名。
- active
表示用户类型是否活跃。
- email
该用户类型联系人的电子邮件ID。
可能的错误
- PATTERN_NOT_MATCHEDHTTP 400
"type" 参数的值无效。
解决方法:"type" 参数只能取以下值之一:
AllUsers,AllActiveUsers,ActiveUsers,DeactiveUsers,NotConfirmedUsers,ConfirmedUsers,以及ActiveConfirmedUsers。 - NO_PERMISSIONHTTP 403
您没有访问该门户的权限。
解决方法:联系您的管理员。
示例响应
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
}
}