飞书开放平台 Server API 文档

主题

查询单个部门 ​

该接口支持通过部门id批量查询当天的部门详情信息，包括部门包含的名称、描述、启用状态等。

Error: 本接口不再推荐使用（不支持更复杂的字段鉴权功能），请使用批量查询部门V2接口（支持对成本中心、部门负责人、自定义字段鉴权）。

Warning: 延迟说明：数据库主从延迟 2s 以内，即：直接创建职级后2s内调用此接口可能查询不到数据。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v1/departments/:department_id
HTTP MethodGET
接口频率限制特殊频控
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可corehr:corehr:readonly 获取核心人事信息 corehr:corehr 更新核心人事信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数 ​

名称类型描述
department_idstring部门ID。ID获取方式： - 调用【创建部门】【搜索部门】等接口可以返回部门ID - 也可以通过【事件】创建部门【事件】更新部门 获取部门ID信息
示例值："45456564"

查询参数 ​

名称类型必填描述
user_id_typestring否用户 ID 类型
示例值：people_corehr_id
可选值有：
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ - people_corehr_id: 以飞书人事的 ID 来识别用户
默认值：people_corehr_id
当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID
department_id_typestring否此次调用中使用的部门 ID 类型
示例值：people_corehr_department_id
可选值有：
- open_department_id: 以 open_department_id 来标识部门 - department_id: 以 department_id 来标识部门 - people_corehr_department_id: 以 people_corehr_department_id 来标识部门
默认值：people_corehr_department_id

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ departmentdepartment部门信息
    └ idstring部门 ID
    └ sub_typeenum部门类型，通过获取字段详情查询获取。请求参数：object_api_name=department；custom_api_name=subtype。
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring枚举值信息的语言，中文为zh-CN，英文为en-US
        └ valuestring枚举值信息的内容
    └ managerstring部门负责人ID - 详细信息可通过【搜索员工信息】 或 【批量查询员工】 接口获取
    └ is_confidentialboolean是否保密（该字段暂无功能支持，可忽略）
    └ hiberarchy_commonhiberarchy_common组织实体公共字段，包括名称、描述、上级、启停用状态、生效日期、编码等基础信息
      └ parent_idstring上级部门 ID ，详细信息可通过【查询单个部门】接口获得
      └ namei18n\[\]名称
        └ langstring名称信息的语言，中文为zh-CN，英文为en-US
        └ valuestring名称信息的内容
      └ typeenum组织类型，枚举值可通过文档【飞书人事枚举常量】组织类型（organization_type）枚举定义部分获得 - 该接口返回值为固定值：department
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring枚举值信息的语言，中文为zh-CN，英文为en-US
          └ valuestring枚举值信息的内容
      └ activeboolean是否启用
      └ effective_timestring当前版本生效日期（和data.effective_time内容一致） - 返回格式：YYYY-MM-DD 00:00:00（最小单位到日） - 日期范围:1900-01-01 00:00:00～9999-12-31 23:59:59
      └ expiration_timestring当前版本失效日期（和data.expiration_time内容一致） - 返回格式：YYYY-MM-DD 00:00:00（最小单位到日） - 日期范围:1900-01-01 00:00:00～9999-12-31 23:59:59
      └ codestring编码
      └ descriptioni18n\[\]描述
        └ langstring描述信息的语言，中文为zh-CN，英文为en-US
        └ valuestring描述信息的内容
      └ tree_orderstring树形排序，代表同层级的部门排序序号 - 创建部门场景tree_order不会实时生成，10分钟内更新完毕 - 在页面拖动部门排序时tree_order可以实时生成 - 变更部门上级时，会清空tree_order，并触发重算list_order和tree_order，10分钟内更新完毕
      └ list_orderstringListOrder 列表排序，代表所有部门的混排序号，为该部门上级路径上所有tree_order用“-”拼接。 - 该字段在新建/更新场景非立即更新，10分钟后会延迟更新 - 由于list_order变更会导致部门变更接口产生大量事件，因此事件接口不会针对该字段同步变更事件，如果有需求订阅请联系Oncall单独开启。
      └ custom_fieldsobject_field_data\[\]自定义字段类型，详细见获取自定义字段列表
        └ field_namestring自定义字段 API Name，即自定义字段的唯一标识
        └ valuestring字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同。如：("\"123\"", "\"123.23\"", "\"true\"", [\"id1\",\"id2\"], \"2006-01-02 15:04:05\")
    └ effective_timestring当前版本生效日期（和data. hiberarchy_common. effective_time内容一致） - 返回格式：YYYY-MM-DD 00:00:00（最小单位到日） - 日期范围:1900-01-01 00:00:00～9999-12-31 23:59:59
    └ expiration_timestring当前版本失效日期（和data. hiberarchy_common.expiration_time内容一致） - 返回格式：YYYY-MM-DD 00:00:00（最小单位到日） - 日期范围:1900-01-01 00:00:00～9999-12-31 23:59:59
    └ custom_fieldsobject_field_data\[\]自定义字段类型，详细见获取自定义字段列表
      └ field_namestring自定义字段 API Name，即自定义字段的唯一标识
      └ valuestring字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")
    └ cost_center_idstring成本中心id，详细信息可通过【搜索成本中心信息】接口查询获得
    └ staffing_modelenum岗职管理模式 - 详细枚举类型请查看枚举场景中关于staffing_model定义
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言，中文为zh-CN，英文为en-US
        └ valuestring内容

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "department": {
            "id": "6969828847121885087",
            "sub_type": {
                "enum_name": "type_1",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "张三"
                    }
                ]
            },
            "manager": "6893013238632416776",
            "is_confidential": true,
            "hiberarchy_common": {
                "parent_id": "4719168654814483759",
                "name": [
                    {
                        "lang": "zh-CN",
                        "value": "张三"
                    }
                ],
                "type": {
                    "enum_name": "type_1",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "张三"
                        }
                    ]
                },
                "active": true,
                "effective_time": "2020-05-01 00:00:00",
                "expiration_time": "2020-05-02 00:00:00",
                "code": "12456",
                "description": [
                    {
                        "lang": "zh-CN",
                        "value": "张三"
                    }
                ],
                "tree_order": "001000",
                "list_order": "001000-001000",
                "custom_fields": [
                    {
                        "field_name": "name",
                        "value": "\"Sandy\""
                    }
                ]
            },
            "effective_time": "2020-05-01 00:00:00",
            "expiration_time": "2020-05-02 00:00:00",
            "custom_fields": [
                {
                    "field_name": "name",
                    "value": "\"Sandy\""
                }
            ],
            "cost_center_id": "7142384817131652652",
            "staffing_model": {
                "enum_name": "position",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "刘梓新"
                    }
                ]
            }
        }
    }
}

内容来源：飞书开放平台 · 自动爬取整理

本镜像仅供学习与查阅，文档版权归飞书所有