获取员工花名册字段信息

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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"
}

修改于 2022-08-30 09:19:21

通过免登码获取用户信息（不推荐）

更新员工花名册

获取员工花名册字段信息

说明#

权限#

请求参数

示例代码

返回响应

说明

权限