查询考勤组下所有成员
查询指定考勤组下的所有成员
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/attendance/v1/groups/:group_id/list_user |
| HTTP Method | GET |
| 接口频率限制 | 50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | attendance:rule 写入打卡管理规则 attendance:rule:readonly 导出打卡管理规则 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
group_id | string | 考勤组 ID,获取方式:1)创建或修改考勤组 2)按名称查询考勤组 3)获取打卡结果 示例值:"6919358128597097404" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
employee_type | string | 是 | 响应体中 user_id 的员工 ID 类型。如果没有后台管理权限,可使用通过手机号或邮箱获取用户 ID 可选值有: 1. employee_id:员工 employee ID,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID 2. employee_no:员工工号,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号 示例值:employee_id |
dept_type | string | 是 | 响应体中 department_ids 的部门 ID 的类型 可选值有: 1. open_id:暂时只支持部门的 openid。具体概念请参考部门资源介绍中的open_department_id 示例值:open_id |
page_size | int | 否 | 分页大小 示例值:10 默认值: 10数据校验规则: - 取值范围: 1 ~ 50 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:92xKiuWrBCSweSZJBSTpag%3D%3D |
member_clock_type | int | 是 | 查询的考勤组成员的打卡类型 可选值有: 0:全部打卡类型 1:需要打卡类型 2:无需打卡类型 示例值:1 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ users | user_base\[\] | 考勤组成员列表 |
└ user_id | string | 用户 ID,对应 employee_type |
└ department_ids | string\[\] | 该用户所属部门 ID 列表,返回结果为该用户所属的部门树,从直属部门到根部门。对应 dept_type |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"users": [
{
"user_id": "5874663B",
"department_ids": [
"od-fcb45c28a45311afd440b7869541fce8"
]
}
],
"page_token": "92xKiuWrBCSweSZJBSTpag%3D%3D",
"has_more": false
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1220001 | invalid parameter | 检查入参 |
| 400 | 1220002 | tenant_id is empty | 检查租户 ID |
| 400 | 1220006 | enterprise tenant app has no privilege | 按照错误信息指引,开启应用权限 |
| 400 | 1220007 | not enterprise tenant | 检查租户权限 |
| 400 | 1220003 | user_id type is not employee_id or employee_no | 无效的用户 ID |
| 500 | 1225000 | system error | 系统错误,可重试解决或咨询技术支持 |
| 500 | 1227000 | management service error | 系统错误,可重试解决或咨询技术支持 |
