Skip to content

查询班表信息

支持查询多个用户的排班情况,注意此接口返回的是用户维度的排班结果,与页面功能并不对应。可以通过返回结果中的group_id查询考勤组按 ID 查询考勤组 ,shift_id查询班次按 ID 查询班次 。查询的时间跨度不能超过 30 天。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/attendance/v1/user_daily_shifts/query
HTTP MethodPOST
接口频率限制50 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用attendance:task:readonly 导出打卡数据

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

查询参数

名称类型必填描述
employee_typestring请求体中的 user_ids 和响应体中的 user_id 的员工ID类型。如果没有后台管理权限,可使用通过手机号或邮箱获取用户 ID
示例值:employee_id
可选值有
- employee_id: 员工 employee ID,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的用户 ID,或者通过手机号或邮箱获取用户 ID获取的userid。 - employee_no: 员工工号,即飞书管理后台 > 组织架构 > 成员与部门 > 成员详情中的工号

请求体

名称类型必填描述
user_idsstring\[\]employee_no 或 employee_id 列表,与employee_type对应。最多50人。
示例值:["abd754f7"]
check_date_fromint查询的起始工作日,格式为yyyyMMdd
示例值:20190817
check_date_toint查询的结束工作日,格式为yyyyMMdd
示例值:20190820

请求体示例

json
{
    "user_ids": [
        "abd754f7"
    ],
    "check_date_from": 20190817,
    "check_date_to": 20190820
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ user_daily_shiftsuser_daily_shift\[\]班表信息列表
    └ group_idstring考勤组 ID,可用于按 ID 查询考勤组
    └ shift_idstring班次 ID,可用于按 ID 查询班次
    └ monthint月份,格式yyyyMM
    └ user_idstring用户 ID,与employee_type对应
    └ day_noint月内日期,最多31天

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "user_daily_shifts": [
            {
                "group_id": "6737202939523236110",
                "shift_id": "6753520403404030215",
                "month": 202101,
                "user_id": "abd754f7",
                "day_no": 21
            }
        ]
    }
}

错误码

HTTP状态码错误码描述排查建议
4001220001param is invalid入参校验失败,请根据具体返回的信息检查入参。例如“employee_type invalid”代表人员类型异常。如仍无法解决可联系 技术支持
4001220002tenant_id is empty请检查入参中的 tenant_access_token是否正确
4001220004param is invalid请参考实际返回的错误信息排查问题。例如“user_id is not exist or does not have permission”代表入参传入的用户id不存在或者没有权限。如仍无法解决可联系 技术支持
4001220005没有权限请前往考勤管理后台检查数据权限范围
4001220600通用错误信息通用错误信息包含多条,详细的错误信息以及处理建议可参见 错误信息
5001225000param is invalid请参考实际返回的错误信息排查问题。例如“internal server error”代表内部服务异常。如仍无法解决可联系 技术支持
5001226000param is invalid班次服务异常错误码,请参考实际返回的错误信息排查问题。例如“internal server error”代表内部服务异常。如仍无法解决可联系 技术支持
5001226003param is invalid请参考实际返回的错误信息排查问题。例如“default shift are not allowed to change.”代表默认班次不能修改。如仍无法解决可联系 技术支持

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