模糊搜索用户
调用该接口模糊搜索用户列表,默认只返回处于“已启用”状态的用户数据。
请求
| 基本 | |
|---|---|
| 请求方式 | GET |
| 请求地址 | /openapi/v3/contacts/users/search |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | 值格式:Bearer {{access_token}}调用 API 时,需要通过访问凭证(access_token)进行身份鉴权,不同类型的访问凭证可获取的数据范围不同,参考 获取访问凭证 。 支持鉴权类型: • 应用级token:以应用身份调用 API,校验应用的数据访问范围。参考 获取企业内部应用access_token。• 用户级token:以登录用户身份调用 API,校验用户的可见数据范围。参考 获取登录用户access_token。 |
| Content-Type | string | 是 | 固定值:application/json; charset=utf-8 |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| query | string | 是 | 查询内容 |
| data_size | int | 否 | 返回data大小 默认10 上限100 |
| department_ids | []string | 否 | 部门内查询 上限10 |
| status | int | 否 | 查询用户的状态 0: 已停用,1: 未激活, 2: 已激活 |
响应
响应体
1{2 "code": 0,3 "msg": "success",4 "data": {5 "users": [6 {7 "avatar": "",8 "join_time": "11-24-2025",9 "name": "张三",10 "status": "Enabled",11 "union_id": "",12 "alias_id": "",13 "username": "zhangsan"14 }15 ]16 }17}
