获取员工字段配置 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

企业内部开发

快速入门服务端API 客户端API 附录更新日志联系我们

企业内部开发服务端API 人事助手花名册获取员工字段配置

获取员工字段配置

最后更新：2024/01/19

通过这个接口获取员工字段配置信息

请求方式：GET(HTTPS)
请求地址：https://qyapi.weixin.qq.com/cgi-bin/hr/get_fields?access_token=ACCESS_TOKEN

参数说明：

参数	必须	说明
access_token	是	调用接口凭证

返回数据：

{
	"errcode":0,
	"errmsg":"ok",
	"group_list":[
		{
			"group_id":1001,
			"group_name":"个人信息",
			"field_list":[
				{
					"fieldid":11001,
					"field_name":"姓名",
					"field_type":1,
					"is_must":true
				},
				{
					"fieldid":11002,
					"field_name":"别名",
					"field_type":1,
					"is_must":false
				}
			]
		},
		{
			"group_id":1002,
			"group_name":"在职信息",
			"field_list":[
				{
					"fieldid":12024,
					"field_name":"工号",
					"field_type":1,
					"is_must":true
				}
			]
		}
	]
}

参数说明：

参数	说明
errcode	返回码
errmsg	对返回码的文本描述
group_list	字段组的配置信息，参考字段组配置信息说明

字段组配置信息说明：

参数	说明
group_id	字段组的id
group_name	字段组的名称
field_list	字段组所包含的所有字段信息，参考字段信息说明

字段信息说明：

参数	说明
field_id	字段的id
field_name	字段的名称
field_type	字段的类型，参考字段类型说明
is_must	字段是否为必填

字段类型说明：

参数	字段类型	对应获取/更新时字段类型
1	文本类型	字符串类型或电话号码类型
2	选项类型	32位非负整数类型
3	时间类型	64位非负整数类型或 64位整数类型
4	图片类型	文件类型
5	单个文件类型	文件类型
6	多个文件类型	文件类型

概述

获取员工花名册信息

本节内容

获取员工字段配置