Skip to content

查询单个公司

根据 ID 查询单个公司。

Warning: 延迟说明:

  • 数据库主从延迟2s以内,即:直接创建公司后2s内调用此接口可能查询不到数据
  • 响应体registered_office_address_info (注册地址)、office_address_info (办公地址)下的full_address_local_script(完整地址,本地文字)、full_address_western_script(完整地址,西方文字)字段为计算字段,延迟5s以内,堆积时会延长

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v1/companies/:company_id
HTTP MethodGET
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可corehr:company:read 获取公司信息 corehr:corehr:readonly 获取核心人事信息 corehr:corehr 更新核心人事信息

请求头

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

路径参数

名称类型描述
company_idstring需要查询的公司ID。ID获取方式: - 调用【创建公司】【批量查询公司】等接口可以返回公司ID
示例值:"151515"

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ companycompany公司信息
    └ idstring公司 ID
    └ hiberarchy_commonhiberarchy_common公司基本信息,该结构维护了公司的名称、编码、启用状态、上级公司等基础信息。
      └ parent_idstring上级 ID - 若查询的是一级公司,则该字段不展示
      └ namei18n\[\]名称
        └ langstring语言信息,中文用zh-CN,英文用en-US
        └ valuestring名称信息的内容
      └ typeenum组织类型,枚举值可通过文档【飞书人事枚举常量】组织类型(organization_type)枚举定义部分获得
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言信息,中文用zh-CN,英文用en-US
          └ valuestring名称信息的内容
      └ activeboolean是否启用
      └ effective_timestring当前版本生效日期 - 返回格式:YYYY-MM-DD 00:00:00(最小单位到日) - 日期范围:1900-01-01 00:00:00~9999-12-31 23:59:59
      └ expiration_timestring当前版本失效日期 - 返回格式: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名称信息的内容
      └ custom_fieldsobject_field_data\[\]自定义字段(该字段暂不支持)
        └ field_namestring字段名
        └ valuestring字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")
    └ typeenum公司性质,通过获取字段详情查询获取。请求参数:object_api_name=company;custom_api_name=type。
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言信息,中文用zh-CN,英文用en-US
        └ valuestring名称信息的内容
    └ industry_listenum\[\]所在行业,通过获取字段详情查询获取。请求参数:object_api_name=company;custom_api_name=industry。
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言信息,中文用zh-CN,英文用en-US
        └ valuestring名称信息的内容
    └ legal_representativei18n\[\]法定代表人
      └ langstring语言信息,中文用zh-CN,英文用en-US
      └ valuestring名称信息的内容
    └ post_codestring邮编
    └ tax_payer_idstring纳税人识别号
    └ confidentialboolean是否保密
    └ sub_type_listenum\[\]主体类型,枚举值可通过文档【飞书人事枚举常量】主体类型(company_sub_type)枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言信息,中文用zh-CN,英文用en-US
        └ valuestring名称信息的内容
    └ branch_companyboolean是否为分公司
    └ primary_manageri18n\[\]主要负责人
      └ langstring语言信息,中文用zh-CN,英文用en-US
      └ valuestring名称信息的内容
    └ custom_fieldsobject_field_data\[\]自定义字段(该字段暂不支持)
      └ field_namestring字段名
      └ valuestring字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")
    └ currencycurrency默认币种
      └ idstring货币 ID。 - 调用【查询货币信息】接口返回货币详细信息
      └ currency_namei18n\[\]货币名称
        └ langstring语言
        └ valuestring内容
      └ numeric_codeint数字代码
      └ currency_alpha_3_codestring法定货币对应代码,如CNY、USD等,通过查询货币信息v2查询获取。
      └ country_region_id_liststring\[\]货币所属国家/地区 ID 列表,详细信息可通过查询国家/地区信息接口查询获得
    └ phonephone_number_and_area_code电话
      └ area_codeenum区号对应的数字,可通过 获取字段详情查询获取。请求参数:object_api_name=phone;custom_api_name=international_area_code
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言
          └ valuestring内容
      └ phone_numberstring号码
    └ faxphone_number_and_area_code传真
      └ area_codeenum区号对应的数字,可通过 获取字段详情查询获取。请求参数:object_api_name=phone;custom_api_name=international_area_code
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言
          └ valuestring内容
      └ phone_numberstring号码
    └ registered_office_addressi18n\[\]完整注册地址
      └ langstring语言
      └ valuestring内容
    └ office_addressi18n\[\]完整办公地址
      └ langstring语言
      └ valuestring内容
    └ registered_office_address_infoaddress注册地址详细信息
      └ full_address_local_scriptstring完整地址(本地文字)
      └ full_address_western_scriptstring完整地址(西方文字)
      └ idstring地址ID
      └ country_region_idstring国家 / 地区id。各国家/地区填写字段可参考地址填写规则查询。 国家/地区id可通过查询国家/地区信息查询获取。
      └ region_idstring主要行政区id。 可通过 查询省份/主要行政区信息查询获取。
      └ city_idstring城市id,可通过 查询城市信息查询获取。
      └ distinct_idstring区/县id,可通过 查询区/县信息查询获取。
      └ address_line1string地址行 1
      └ address_line2string地址行 2
      └ address_line3string地址行 3
      └ address_line4string地址行 4
      └ address_line5string地址行 5
      └ address_line6string地址行 6
      └ address_line7string地址行 7
      └ address_line8string地址行 8
      └ address_line9string地址行 9
      └ local_address_line1string地址行 1(非拉丁语系的本地文字)
      └ local_address_line2string地址行 2(非拉丁语系的本地文字)
      └ local_address_line3string地址行 3(非拉丁语系的本地文字)
      └ local_address_line4string地址行 4(非拉丁语系的本地文字)
      └ local_address_line5string地址行 5(非拉丁语系的本地文字)
      └ local_address_line6string地址行 6(非拉丁语系的本地文字)
      └ local_address_line7string地址行 7(非拉丁语系的本地文字)
      └ local_address_line8string地址行 8(非拉丁语系的本地文字)
      └ local_address_line9string地址行 9(非拉丁语系的本地文字)
      └ postal_codestring邮政编码
      └ address_type_listenum\[\]地址类型
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言
          └ valuestring内容
      └ is_primaryboolean主要地址
      └ is_publicboolean公开地址
    └ office_address_infoaddress办公地址详细信息
      └ full_address_local_scriptstring完整地址(本地文字)
      └ full_address_western_scriptstring完整地址(西方文字)
      └ idstring地址ID
      └ country_region_idstring国家 / 地区id。各国家/地区填写字段可参考地址填写规则查询。 国家/地区id可通过查询国家/地区信息查询获取。
      └ region_idstring主要行政区id。 可通过 查询省份/主要行政区信息查询获取。
      └ city_idstring城市id,可通过 查询城市信息查询获取。
      └ distinct_idstring区/县id,可通过 查询区/县信息查询获取。
      └ address_line1string地址行 1
      └ address_line2string地址行 2
      └ address_line3string地址行 3
      └ address_line4string地址行 4
      └ address_line5string地址行 5
      └ address_line6string地址行 6
      └ address_line7string地址行 7
      └ address_line8string地址行 8
      └ address_line9string地址行 9
      └ local_address_line1string地址行 1(非拉丁语系的本地文字)
      └ local_address_line2string地址行 2(非拉丁语系的本地文字)
      └ local_address_line3string地址行 3(非拉丁语系的本地文字)
      └ local_address_line4string地址行 4(非拉丁语系的本地文字)
      └ local_address_line5string地址行 5(非拉丁语系的本地文字)
      └ local_address_line6string地址行 6(非拉丁语系的本地文字)
      └ local_address_line7string地址行 7(非拉丁语系的本地文字)
      └ local_address_line8string地址行 8(非拉丁语系的本地文字)
      └ local_address_line9string地址行 9(非拉丁语系的本地文字)
      └ postal_codestring邮政编码
      └ address_type_listenum\[\]地址类型
        └ enum_namestring枚举值
        └ displayi18n\[\]枚举多语展示
          └ langstring语言
          └ valuestring内容
      └ is_primaryboolean主要地址
      └ is_publicboolean公开地址

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "company": {
            "id": "4692472714243080020",
            "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": "张三"
                    }
                ],
                "custom_fields": [
                    {
                        "field_name": "name",
                        "value": "\"Sandy\""
                    }
                ]
            },
            "type": {
                "enum_name": "type_1",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "张三"
                    }
                ]
            },
            "industry_list": [
                {
                    "enum_name": "type_1",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "张三"
                        }
                    ]
                }
            ],
            "legal_representative": [
                {
                    "lang": "zh-CN",
                    "value": "张三"
                }
            ],
            "post_code": "邮编",
            "tax_payer_id": "123456840",
            "confidential": true,
            "sub_type_list": [
                {
                    "enum_name": "type_1",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "张三"
                        }
                    ]
                }
            ],
            "branch_company": true,
            "primary_manager": [
                {
                    "lang": "zh-CN",
                    "value": "张三"
                }
            ],
            "custom_fields": [
                {
                    "field_name": "name",
                    "value": "\"Sandy\""
                }
            ],
            "currency": {
                "id": "1",
                "currency_name": [
                    {
                        "lang": "zh-CN",
                        "value": "刘梓新"
                    }
                ],
                "numeric_code": 12,
                "currency_alpha_3_code": "12",
                "country_region_id_list": [
                    "6862995757234914824"
                ]
            },
            "phone": {
                "area_code": {
                    "enum_name": "phone_type",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "刘梓新"
                        }
                    ]
                },
                "phone_number": "213213"
            },
            "fax": {
                "area_code": {
                    "enum_name": "phone_type",
                    "display": [
                        {
                            "lang": "zh-CN",
                            "value": "刘梓新"
                        }
                    ]
                },
                "phone_number": "213213"
            },
            "registered_office_address": [
                {
                    "lang": "zh-CN",
                    "value": "刘梓新"
                }
            ],
            "office_address": [
                {
                    "lang": "zh-CN",
                    "value": "刘梓新"
                }
            ],
            "registered_office_address_info": {
                "full_address_local_script": "中国北京北京",
                "full_address_western_script": "Beijing, Beijing, China,",
                "id": "6989822217869624863",
                "country_region_id": "6862995757234914824",
                "region_id": "6863326815667095047",
                "city_id": "6863333254578046471",
                "distinct_id": "6863333516579440141",
                "address_line1": "丹佛测试地址-纽埃时区",
                "address_line2": "PoewH",
                "address_line3": "PoewH",
                "address_line4": "jmwJc",
                "address_line5": "jmwJc",
                "address_line6": "jmwJc",
                "address_line7": "jmwJc",
                "address_line8": "rafSu",
                "address_line9": "McPRG",
                "local_address_line1": "丹佛测试地址-纽埃时区",
                "local_address_line2": "PoewH",
                "local_address_line3": "PoewH",
                "local_address_line4": "jmwJc",
                "local_address_line5": "jmwJc",
                "local_address_line6": "jmwJc",
                "local_address_line7": "jmwJc",
                "local_address_line8": "rafSu",
                "local_address_line9": "McPRG",
                "postal_code": "611530",
                "address_type_list": [
                    {
                        "enum_name": "phone_type",
                        "display": [
                            {
                                "lang": "zh-CN",
                                "value": "刘梓新"
                            }
                        ]
                    }
                ],
                "is_primary": true,
                "is_public": true
            },
            "office_address_info": {
                "full_address_local_script": "中国北京北京",
                "full_address_western_script": "Beijing, Beijing, China,",
                "id": "6989822217869624863",
                "country_region_id": "6862995757234914824",
                "region_id": "6863326815667095047",
                "city_id": "6863333254578046471",
                "distinct_id": "6863333516579440141",
                "address_line1": "丹佛测试地址-纽埃时区",
                "address_line2": "PoewH",
                "address_line3": "PoewH",
                "address_line4": "jmwJc",
                "address_line5": "jmwJc",
                "address_line6": "jmwJc",
                "address_line7": "jmwJc",
                "address_line8": "rafSu",
                "address_line9": "McPRG",
                "local_address_line1": "丹佛测试地址-纽埃时区",
                "local_address_line2": "PoewH",
                "local_address_line3": "PoewH",
                "local_address_line4": "jmwJc",
                "local_address_line5": "jmwJc",
                "local_address_line6": "jmwJc",
                "local_address_line7": "jmwJc",
                "local_address_line8": "rafSu",
                "local_address_line9": "McPRG",
                "postal_code": "611530",
                "address_type_list": [
                    {
                        "enum_name": "phone_type",
                        "display": [
                            {
                                "lang": "zh-CN",
                                "value": "刘梓新"
                            }
                        ]
                    }
                ],
                "is_primary": true,
                "is_public": true
            }
        }
    }
}

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