Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
服务端API
  • 历史文档（不推荐）
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API（DingTalk OpenAPI）
  • 生态伙伴API
获取凭证（access_token）身份验证（免登）应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理（官方CRM）培训智能硬件
获取凭证（access_token）身份验证（免登）应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理（官方CRM）培训智能硬件
  1. 部门管理
  • 用户管理
    • 创建用户
      POST
    • 更新用户信息
      POST
    • 删除用户
      POST
    • 根据userid获取用户详情
      POST
    • 获取部门用户基础信息
      POST
    • 获取部门用户userid列表
      POST
    • 获取部门用户详情
      POST
    • 获取员工人数
      POST
    • 获取未登录钉钉的员工列表
      POST
    • 根据手机号获取userid
      POST
    • 根据unionid获取用户userid
      POST
    • 获取管理员列表
      POST
    • 获取管理员通讯录权限范围
      POST
    • 获取管理员的应用管理权限
      GET
  • 部门管理
    • 创建部门
      POST
    • 更新部门
      POST
    • 删除部门
      POST
    • 获取部门详情
      POST
    • 获取部门列表
      POST
    • 获取子部门ID列表
      POST
    • 获取指定部门的所有父部门列表
      POST
    • 获取指定用户的所有父部门列表
      POST
  • 角色管理
    • 创建角色
      POST
    • 创建角色组
      POST
    • 更新角色
      POST
    • 批量增加员工角色
      POST
    • 删除角色
      POST
    • 批量删除员工角色
      POST
    • 设定角色成员管理范围
      POST
    • 获取角色组列表
      POST
    • 获取角色列表
      POST
    • 获取角色详情
      POST
    • 获取指定角色的员工列表
      POST
  • 外部联系人
    • 添加外部联系人
    • 删除外部联系人
    • 更新外部联系人
    • 获取外部联系人列表
    • 获取外部联系人标签列表
    • 获取外部联系人详情
  • 行业通讯录
    • 获取部门详情
    • 获取部门下人员列表
    • 获取部门列表
    • 获取部门用户详情
    • 获取企业信息
  • 获取通讯录权限范围
    GET
  1. 部门管理

获取部门列表

POST
http://127.0.0.1/topapi/v2/department/listsub
服务端API/通讯录管理/部门管理
最后修改时间：2022-08-30 09:19:22
责任人：未设置

说明#

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

权限#

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

请求参数

Query 参数
access_token
string 
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
bE74xxxx
Body 参数application/json
dept_id
number 
可选
父部门ID。如果不传，默认部门为根部门，根部门ID为1。只支持查询下一级子部门，不支持查询多级子部门。
language
string 
可选
通讯录语言：zh_CN（默认）：中文en_US：英文
示例
{
  "language": "zh_CN",
  "dept_id": 1
}

示例代码

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/v2/department/listsub?access_token=bE74xxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "language": "zh_CN",
    "dept_id": 1
}'

返回响应

🟢200成功
application/json
Body
request_id
string 
请求ID。
可选
errcode
number 
返回码。
可选
errmsg
string 
可选
调用失败时返回的错误信息。
result
array [object {5}] 
部门列表。
可选
dept_id
number 
部门ID。
可选
name
string 
部门名称。
可选
parent_id
number 
父部门ID。
可选
create_dept_group
boolean 
可选
是否同步创建一个关联此部门的企业群：true：创建false：不创建
auto_add_user
boolean 
可选
部门群已经创建后，有新人加入部门是否会自动加入该群：true：会自动入群false：不会
示例
{
  "request_id": "string",
  "errcode": 0,
  "errmsg": "string",
  "result": [
    {
      "dept_id": 0,
      "name": "string",
      "parent_id": 0,
      "create_dept_group": true,
      "auto_add_user": true
    }
  ]
}
上一页
获取部门详情
下一页
获取子部门ID列表
Built with