按类型获取来源
目的
按类型获取用户组成员的详细信息。
端点
- GET /settings/user_groups/{group_ID}/sources
请求详情
请求 URL
{api-domain}/crm/{version}/settings/user_groups/{group_id}/sources
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.settings.user_groups.READ
参数
- type如果要按类型过滤,则为必填项
按类型获取组成员的详细信息。可能的值是用户、角色、组和区域。
- user_type如果要按用户类型过滤,则为必填项
按用户类型获取组成员的详细信息。可能的值是活跃、非活跃和已删除。
- page number,optional
获取相应页面的记录列表。默认值为1。
- per_page number,optional
获取每页可用的记录列表。默认值和最大可能值为200。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/user_groups/3652397000009952001/sources?type=roles"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"响应 JSON 键
- sourceJSON 对象
这包含基于类型的名称和ID。
- 对于 type=users - 用户组中用户的名称和ID。
- 对于 type=roles - 用户组中角色的名称和ID。
- 对于 type=territories - 用户组中领地的名称和ID。
- 对于 type=groups - 此用户组中其他用户组的名称和ID。
- typestring
根据您筛选用户组的类型。
- subordinatesstring
表示此来源是否有下属的布尔字段。
- infoJSON object
在此 API 调用中获取的记录数 (count)、页码 (page)、每页记录数 (per_page),以及是否存在尚未获取的更多记录 (more_records)。
可能的错误
- INVALID_DATAHTTP 400
在URL中,组ID不正确。
解决方法:指定一个有效的组ID。使用获取用户组API来获取用户组的ID。
示例响应
Copied{
"sources": [
{
"source": {
"name": "CEO",
"id": "3652397000000026005"
},
"type": "roles",
"subordinates": false
},
{
"source": {
"name": "Manager",
"id": "3652397000000026008"
},
"type": "roles",
"subordinates": true
}
],
"info": {
"per_page": 200,
"count": 2,
"page": 1,
"more_records": false
}
}