搜索用户
GET /apiv2/users/search.json?query={query}
Query参数
Name | Required | Type | Comment |
---|---|---|---|
query | 是 | string | 搜索关键词,在未使用参数 exact_query_fields 的时候该参数必填 |
query_fields | 否 | string | 搜索的字段名,多个字段用英文逗号分割, 可选值:name、email、phone、landline、wechat_openid |
调用权限
agent
接口示例
模糊搜索 GET /apiv2/users/search.json?query=刘先生 在姓名和邮箱中搜索 GET /apiv2/users/search.json?query=support&query_fields=name,email
curl 示例
curl https://{subdomain}.kf5.com/apiv2/users/search.json?query=刘先生 \ -v -u {email_address}:{password}
返回示例
Status: 200 OK{ "users": [ { "id": 523, "name": "刘先生", ... } ]}