组织云钉钉API
  1. 用户管理
组织云钉钉API
  • 服务端API
    • 如何调用服务端API
    • 服务端SDK下载
    • 获取凭证(access_token)
      • 获取企业内部应用的access_token
      • 获取jsapi_ticket
    • 身份验证(免登)
      • 企业内部应用免登
      • 免登常见问题
    • 通讯录管理
      • 通讯录事件
      • 用户管理
        • 创建用户
          POST
        • 更新用户信息
          POST
        • 删除用户
          POST
        • 根据userid获取用户详情
          POST
        • 获取部门用户基础信息
          POST
        • 获取部门用户userid列表
          POST
        • 获取部门用户详情
          POST
        • 获取员工人数
          POST
        • 获取未登录钉钉的员工列表
          POST
        • 根据手机号获取userid
          POST
        • 根据unionid获取用户userid
          POST
        • 获取管理员列表
          POST
        • 获取管理员通讯录权限范围
          POST
        • 获取管理员的应用管理权限
          GET
      • 部门管理
        • 获取部门详情
        • 获取部门列表
        • 获取子部门ID列表
        • 获取指定部门的所有父部门列表
        • 获取指定用户的所有父部门列表
      • 角色管理
        • 删除角色
        • 创建角色
        • 创建角色组
        • 更新角色
        • 批量增加员工角色
        • 批量删除员工角色
        • 设定角色成员管理范围
        • 获取角色组列表
        • 获取角色列表
        • 获取角色详情
        • 获取指定角色的员工列表
    • 消息通知
      • 消息通知概述
      • 消息类型与数据格式
      • 消息链接说明
      • 工作通知
        • 发送工作通知
        • 更新工作通知状态栏
        • 获取工作通知消息的发送进度
        • 获取工作通知消息的发送结果
        • 撤回工作通知消息
      • 普通消息
        • 发送普通消息
  • 钉钉回调相关
    • 钉钉Stream回调
    • 事件订阅列表
  1. 用户管理

获取部门用户详情

POST
/topapi/v2/user/list
企业内部应用第三方企业应用oapi

说明#

调用本接口获取指定部门中的用户详细信息。
服务地址:https://oapi.dingtalk.com

权限#

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

请求参数

Query 参数
access_token
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
be3Fxxxx
Body 参数application/json
dept_id
number 
必需
部门ID,根部门ID为1。只获取当前部门下的员工信息,不包含子部门内的员工。
cursor
number 
必需
分页查询的游标,最开始传0,后续传返回参数中的next_cursor值。
size
number 
分页大小。
必需
order_field
string 
可选
部门成员的排序规则,默认不传是按自定义排序(custom):entry_asc:代表按照进入部门的时间升序entry_desc:代表按照进入部门的时间降序modify_asc:代表按照部门信息修改时间升序modify_desc:代表按照部门信息修改时间降序custom:代表用户定义(未定义时按照拼音)排序
contain_access_limit
boolean 
可选
是否返回访问受限的员工。
language
string 
可选
通讯录语言,取值。zh_CN:中文(默认值)。en_US:英文。
示例
{
        "cursor":0,
        "contain_access_limit":false,
        "size":10,
        "order_field":"modify_desc",
        "language":"zh_CN",
        "dept_id":10
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/topapi/v2/user/list?access_token=be3Fxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
        "cursor":0,
        "contain_access_limit":false,
        "size":10,
        "order_field":"modify_desc",
        "language":"zh_CN",
        "dept_id":10
}'

返回响应

🟢200成功
application/json
Body
errcode
number 
可选
错误码,0代表成功。
errmsg
string 
返回码描述。
可选
result
object 
返回结果。
可选
has_more
boolean 
可选
是否还有更多的数据。
next_cursor
number 
可选
下一次分页的游标,如果has_more为false,表示没有更多的分页数据。
list
array [object {25}] 
用户信息列表。
可选
示例
{
    "errcode": 0,
    "errmsg": "string",
    "result": {
        "has_more": true,
        "next_cursor": 0,
        "list": [
            {
                "userid": "string",
                "unionid": "string",
                "name": "string",
                "avatar": "string",
                "state_code": "string",
                "mobile": "string",
                "hide_mobile": true,
                "telephone": "string",
                "job_number": "string",
                "title": "string",
                "email": "string",
                "org_email": "string",
                "work_place": "string",
                "remark": "string",
                "dept_id_list": [
                    0
                ],
                "dept_order": 0,
                "extension": "string",
                "hired_date": 0,
                "active": true,
                "admin": true,
                "boss": true,
                "leader": true,
                "exclusive_account": true,
                "login_id": "string",
                "exclusive_account_type": "string"
            }
        ]
    }
}
修改于 2023-12-26 06:53:24
上一页
获取部门用户userid列表
下一页
获取员工人数
Built with