飞书项目帮助中心

Appearance

Return to top
页面导航

获取空间详情

请求体说明

类别值
请求地址{base_url}/open_api/projects/detail
请求方式POST

请求 Header

字段值必须填写
Content-Typeapplication/json必须
X-PLUGIN-TOKEN用户在开放平台中获取的 Token，参考插件身份凭证章节。必须
X-USER-KEY当选择使用插件身份凭证的时候，需要额外必选指定接口调用的用户user_key，user_key可双击用户头像获取可选
X-IDEM-UUID写类型接口的幂等串，可以不设置，设置后会进行同一个X-PLUGIN-TOKEN下同一接口的幂等判断可选

参考请求格式如下：

curl --location -g --request GET '{{base_url}}/open_api/projects' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''

请求参数

参数名是否必填值类型说明
project_keys否list[string]查询空间 ID、 project_key 列表
user_key是string指定用户查询
simple_names否list[string]查询空间域名simple_name列表
tenant_group_id否int指定渠道查询，仅渠道用户填写，渠道id 通过获取用户详情得到。

project_keys 和 simple_names 有什么区别？

无区别，project_keys 和 simple_names 选一个必填即可。

请求体格式 

{
    "user_key": "XXX",
    "project_keys": [
        "123214"
    ],
    "simple_names":[
        "zjq-test"
    ]
}

返回值类型 

map<string,Project>

返回格式 

{
    "data": {
        "6152cded56067b48fee98eec": {
            "administrators": [ // 管理员user_key列表，仅当查询用户有空间管理员权限才可见该信息
                "7012910488xxxx",
                "6899912910xxxx"
            ],
            "name": "xxx空间", // 空间名
            "project_key": "6152cded560xxxxx", // project_key
            "simple_name": "xxxyyy" // 空间域名
        }
    },
    "err": {},
    "err_msg": "",
    "err_code": 0
}