获取用户列表
GET /apiv2/users.json
Query参数
| Name | Required | Type | Comment |
|---|---|---|---|
| role | 否 | string | 用户角色，可选值：admin、agent、end_user，可组合使用如：admin,agent |
| created_start | 否 | string | 按创建时间筛选，开始时间 |
| created_end | 否 | string | 按创建时间筛选，结束时间 |
| updated_start | 否 | string | 按更新时间筛选，开始时间 |
| updated_end | 否 | string | 按更新时间筛选，结束时间 |
| created_order | 否 | string | 按创建时间排序，可选值：asc、desc |
| updated_order | 否 | string | 按更新时间排序，可选值：asc、desc |
| relation_source | 否 | string | 固定值 custom_im，同时配合参数 appid、openid 一起使用 |
| appid | 否 | integer | 自定义 IM 的 ID，可在工单系统后台查看：设置>>客服接入渠道>>自定义IM来源 |
| openid | 否 | integer|string | 自定义 IM 用户的 openid |
| page | 否 | number | 页码，默认为 1 |
| per_page | 否 | number | 分页尺寸，默认为 100 |
| 备注：按创建和更新时间进行筛选的参数 created_start、created_end、updated_start、updated_end，支持日期格式（如 2016-01-01 00:00:00）和时间戳（秒级别的整型）。 | |||
还可以使用如下API:
GET /apiv2/organizations/{id}/users.json调用权限
agent
curl 示例
curl https://{subdomain}.kf5.com/apiv2/users.json \
-v -u {email_address}:{password}返回示例
Status: 200{
"users": [
{
"id": 523,
"name": "Agent",
... },
{
"id": 566,
"name": "admin",
... }
]}