Skip to content

查询考勤组下所有成员

查询指定考勤组下的所有成员

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/attendance/v1/groups/:group_id/list_user
HTTP MethodGET
接口频率限制50 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可attendance:rule 写入打卡管理规则 attendance:rule:readonly 导出打卡管理规则

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

名称类型描述
group_idstring考勤组 ID,获取方式:1)创建或修改考勤组 2)按名称查询考勤组 3)获取打卡结果
示例值:"6919358128597097404"

查询参数

名称类型必填描述
employee_typestring响应体中 user_id 的员工 ID 类型。如果没有后台管理权限,可使用通过手机号或邮箱获取用户 ID
可选值有: 1. employee_id:员工 employee ID,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID 2. employee_no:员工工号,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号
示例值:employee_id
dept_typestring响应体中 department_ids 的部门 ID 的类型
可选值有: 1. open_id:暂时只支持部门的 openid。具体概念请参考部门资源介绍中的open_department_id
示例值:open_id
page_sizeint分页大小
示例值:10
默认值10
数据校验规则
- 取值范围:150
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:92xKiuWrBCSweSZJBSTpag%3D%3D
member_clock_typeint查询的考勤组成员的打卡类型
可选值有:
0:全部打卡类型 1:需要打卡类型 2:无需打卡类型
示例值:1

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ usersuser_base\[\]考勤组成员列表
    └ user_idstring用户 ID,对应 employee_type
    └ department_idsstring\[\]该用户所属部门 ID 列表,返回结果为该用户所属的部门树,从直属部门到根部门。对应 dept_type
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "users": [
            {
                "user_id": "5874663B",
                "department_ids": [
                    "od-fcb45c28a45311afd440b7869541fce8"
                ]
            }
        ],
        "page_token": "92xKiuWrBCSweSZJBSTpag%3D%3D",
        "has_more": false
    }
}

错误码

HTTP状态码错误码描述排查建议
4001220001invalid parameter检查入参
4001220002tenant_id is empty检查租户 ID
4001220006enterprise tenant app has no privilege按照错误信息指引,开启应用权限
4001220007not enterprise tenant检查租户权限
4001220003user_id type is not employee_id or employee_no无效的用户 ID
5001225000system error系统错误,可重试解决或咨询技术支持
5001227000management service error系统错误,可重试解决或咨询技术支持

内容来源:飞书开放平台 · 自动爬取整理