Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
历史文档(不推荐)
  • 历史文档(不推荐)
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API(DingTalk OpenAPI)
  • 生态伙伴API
HTTP回调审批待办通讯录管理钉钉红包身份验证(免登)花名册行业连接日程
HTTP回调审批待办通讯录管理钉钉红包身份验证(免登)花名册行业连接日程
  1. 花名册
  • 获取员工花名册字段信息
    POST
  • 更新员工花名册
    POST
  1. 花名册

获取员工花名册字段信息

POST
http://127.0.0.1/topapi/smartwork/hrm/employee/list
历史文档(不推荐)/花名册
最后修改时间:2022-08-30 09:19:21
责任人:未设置

说明#

调用本接口根据员工userid批量获取员工花名册字段信息。
服务地址:https://oapi.dingtalk.com

权限#

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。详情请参考接口权限。
应用类型是否支持调用权限申请方式API Explorer调试
企业内部应用是开发者后台申请调试
第三方企业应用否——
第三方个人应用否——

请求参数

Query 参数
access_token
string 
必需
调用服务端API授权凭证,可通过获取企业内部应用的access_token接口获取。
示例值:
6d1bxxxx
Body 参数application/json
userid_list
string 
必需
员工userid列表,最大列表长度为50。
field_filter_list
string 
可选
需要获取的花名册字段列表,最大列表长度为20。不传入该参数时,企业可获取所有字段信息。
示例
{
  "field_filter_list": "[\"hrm-sys01-employeeStatus\", \"hrm-sys01-regularTime\"]",
  "agentid": "1",
  "userid_list": "[\"1\", \"2\", \"3\"]"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/topapi/smartwork/hrm/employee/list?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "field_filter_list": "[\"hrm-sys01-employeeStatus\", \"hrm-sys01-regularTime\"]",
    "agentid": "1",
    "userid_list": "[\"1\", \"2\", \"3\"]"
}'

返回响应

🟢200成功
application/json
Body
result
array [object {3}] 
返回结果。
可选
userid
string 
可选
员工的userid。
field_list
array [object {5}] 
字段信息列表。
可选
partner
boolean 
可选
是否是合伙伙伴:false:不是true:是
errcode
number 
返回码。
可选
errmsg
string 
返回码描述。
可选
success
boolean 
调用是否成功。
可选
request_id
string 
请求ID。
可选
示例
{
  "result": [
    {
      "userid": "string",
      "field_list": [
        {
          "group_id": "string",
          "value": "string",
          "field_code": "string",
          "field_name": "string",
          "label": "string"
        }
      ],
      "partner": true
    }
  ],
  "errcode": 0,
  "errmsg": "string",
  "success": true,
  "request_id": "string"
}
下一页
更新员工花名册
Built with