CRM getUsers 方法
目的
您可以使用 getUsers 方法获取您机构中的用户列表。
请求 URL
XML 格式：
https://crm.zoho.com.cn/crm/private/xml/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User
JSON 格式：
https://crm.zoho.com.cn/crm/private/json/Users/getUsers?authtoken=Auth Token&scope=crmapi&type=The Type of User
请求参数
| 参数 | 数据类型 | 说明 |
| authtoken* | 字符串 | 验证您的 Zoho 凭据的加密字母数字字符串。 |
| scope* | 字符串 | 将数值指定为crmapi。 |
| newFormat | 整数值 | newFormat=1： 插入来自您的 CRM 账户的数据时排除有 "null" 的字段。 newFormat=2： 插入来自您的 CRM 账户的数据时将有 "null" 的字段包括在内。 |
| 版本 | 整数值 | version = 1： （默认值）这将基于之前的 API 执行即在进行强化之前获取响应。 version = 2： 这将基于上一次 API 执行获取响应。 |
| type* | 字符串 | 此参数使用以下值之一： AllUsers 列出您的机构中所有用户（活跃和不活跃用户） ActiveUsers 获取所有活跃用户列表 DeactiveUsers 获取所有取消激活用户列表 AdminUsers 获取有管理权限的所有用户列表 ActiveConfirmedAdmins 获取有管理权限并得到确认的用户列表 |
* - 必填参数
注意：
- 参考发布说明页面了解关于 API 执行中进行的强化的更多信息。
样本响应
在此案例中，type = AllUsers
<users>
<user id="501240000000541313" email="andrew@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">andrew</user>
<user id="501234132412341135" email="tyson@zohocorp.com" role="Manager" profile="Standard" status="active" confirm="true">tyson</user>
<user id="501234565431234521" email="kelly@zohocorp.com" role="Manager" profile="Standard" status="active" confirm="false">kelly</user>
<user id="512343454676898643" email="frank@zohocorp.com" role="CEO" profile="Standard" status="active" confirm="false">frank</user>
<user id="512445678909865545" email="sophia@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">sophia</user>
</users>
如果 version = 2，您将在响应中得到机构 id。 但是，您的 CRM 记录中不可提供公司详细信息以便在响应中获取机构 id。
<users orgid="501240000000652982">
<user id="501240000000541313" zuid="11381966" website="null" mobile="888-555-2146" fax="null" street="null" city="null" state="null" country="null" zip="null" language="en_US" timezone="PST8PDT" email="andrew@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">andrew</user>
<user id="512445678909865545" zuid="11385946" website="null" mobile="null" fax="null" street="null" city="null" state="null" country="null" zip="null" language="en_US" timezone="America/Los_Angeles" email="sophia@zohocorp.com" role="CEO" profile="Administrator" status="active" confirm="true">sophia</user>
</users>