获取团队下页面组列表

GET 
https://your-domain/openapi/v2/wiki/spaces

History

Version	Changes
v6.2.16	Added in: v6.2.16

获取团队下页面组列表。

Request

Query Parameters

teamID stringrequired

团队ID

requestUserID string

用户 ID，此参数仅在作为 Oauth 机器人调用时才能传递。它用于以指定用户的身份执行操作

Responses

200

成功

application/json

Schema

Schema

data

object

spaces

object[]

Array [

id string

页面组 ID

title string

页面组名称

description string

页面组描述

homePageID string

主页 ID

createdTime integer

创建时间

updatedTime integer

更新时间

creatorID string

创建者 ID

isOpenPublic boolean

是否开启公开发布

isOpenShare boolean

是否开启内部分享

isPin boolean

是否置顶

]

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

errorData object

本次请求错误元数据

Example (from schema)

{
  "data": {
    "spaces": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "homePageID": "string",
        "createdTime": 0,
        "updatedTime": 0,
        "creatorID": "string",
        "isOpenPublic": true,
        "isOpenShare": true,
        "isPin": true
      }
    ]
  },
  "result": "string",
  "errorCode": "string",
  "errorMsg": "string",
  "errorData": {}
}

401

如果身份验证凭据不正确或丢失，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

如果scope检验不通过，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

如果未找到资源对象，则返回

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

内部服务器错误

application/json

Schema

Schema

result string

本次请求结果,SUCCESS|FAIL

errorCode string

本次请求错误码

errorMsg string

本次请求错误信息

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://your-domain/openapi/v2/wiki/spaces' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://your-domain/openapi/v2

Auth

Bearer Token

Parameters

teamID — queryrequired

requestUserID — query

ResponseClear

Click the Send API Request button above and see the response here!