获取部门用户详情

GET

http://127.0.0.1/user/listbypage

历史文档（不推荐）/通讯录管理/用户管理1.0(不推荐)

最后修改时间：2022-08-30 09:19:22

责任人：未设置

说明

调用本接口获取部门用户详情。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考权限申请。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	是	开发者后台申请	调试
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。

示例值:

6ed1bxxx

lang

string

可选

通讯录语言，默认为zh_CN。如果是英文，请输入en_US。

示例值:

zh_CN

department_id

string

必需

获取的部门ID。1表示根部门，可调用获取部门列表。只获取当前部门下的员工信息，不包含子部门内的员工。

示例值:

offset

string

必需

支持分页查询，与size参数同时设置时才生效，此参数代表偏移量，偏移量从0开始。

示例值:

size

string

必需

支持分页查询，与offset参数同时设置时才生效，此参数代表分页大小，最大100。

示例值:

order

string

可选

支持分页查询，部门成员的排序规则，默认不传是按自定义排序：entry_asc：代表按照进入部门的时间升序entry_desc：代表按照进入部门的时间降序modify_asc：代表按照部门信息修改时间升序modify_desc：代表按照部门信息修改时间降序custom：代表用户定义(未定义时按照拼音)排序

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'http://127.0.0.1/user/listbypage?access_token=6ed1bxxx&department_id=1&offset=1&size=1' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

hasMore

boolean

可选

在分页查询时返回，代表是否还有下一页更多数据。false：无下一页数据true：有下一页数据

userlist

array [object {21}]

成员列表。

可选

userid

string

可选

员工在当前企业内的唯一标识，也称staffId。可由企业在创建时指定，并代表一定含义比如工号，创建后不可修改。

order

number

可选

表示员工在此部门中的排序，列表是按order的倒序排列输出的，即从大到小排列输出的。管理员在管理后台里面调整了顺序后，order才有值。

unionid

string

可选

员工在当前开发者企业账号范围内的唯一标识，系统生成，固定值，不会改变。

mobile

string

可选

手机号。第三方企业应用不返回该参数。

tel

string

可选

分机号。第三方企业应用不返回该参数。

workPlace

string

可选

办公地点。第三方企业应用不返回该参数。

remark

string

可选

备注。第三方企业应用不返回该参数。

isAdmin

boolean

可选

是否为企业的管理员：true：表示是false：表示不是

isBoss

boolean

可选

是否为企业的老板：true：表示是false：表示不是

isHide

boolean

可选

是否号码隐藏：true：表示隐藏false：表示不隐藏

isLeader

boolean

可选

是否是部门的主管：true：表示是false：表示不是

name

string

成员名称。

可选

active

boolean

可选

是否激活了钉钉：true：已激活false：未激活

department

array[number]

部门信息。

可选

position

string

职位信息。

可选

string

可选

员工邮箱。第三方企业应用不返回该参数。

orgEmail

string

可选

员工的企业邮箱。如果员工的企业邮箱没有开通，返回信息中不包含该数据。第三方企业应用不返回该参数。

avatar

string

头像URL。

可选

jobnumber

string

可选

员工工号，对应显示到OA后台和客户端个人资料的工号栏目。

hiredDate

string

入职时间。

可选

extattr

string

可选

设置的扩展属性。第三方企业应用不返回该参数。

示例

{
  "errcode": 0,
  "errmsg": "string",
  "hasMore": true,
  "userlist": [
    {
      "userid": "string",
      "order": 0,
      "unionid": "string",
      "mobile": "string",
      "tel": "string",
      "workPlace": "string",
      "remark": "string",
      "isAdmin": true,
      "isBoss": true,
      "isHide": true,
      "isLeader": true,
      "name": "string",
      "active": true,
      "department": [
        0
      ],
      "position": "string",
      "email": "string",
      "orgEmail": "string",
      "avatar": "string",
      "jobnumber": "string",
      "hiredDate": "string",
      "extattr": "string"
    }
  ]
}

获取部门用户userid列表

获取员工人数

获取部门用户详情

说明#

权限#

请求参数

示例代码

返回响应

说明

权限