Get space page tree

GET 
/wiki/spaces/:spaceID/pages

History

Version	Changes
v6.2.16	Added in: v6.2.16
v6.12.0	Detailed distinction between refType in response，add locked property

Get page tree of the space.

Request

Path Parameters

spaceID stringrequired

The space ID

Query Parameters

teamID stringrequired

The team ID

requestUserID string

User ID, this parameter can only be passed when calling as an Oauth bot. It is used to perform operations as the specified user

archived boolean

Default false, true: Get space archived page tree, false: Get space normal page tree

Responses

200

Request is successful.

application/json

Schema

Schema

data

object

pages

object[]

Array [

id string

The page ID

title string

The page title

spaceID string

The space ID

createdTime integer

The createdTime of page

updatedTime integer

The updatedTime of page

parentID string

The parent page ID

refType string

The reference type

refID string

The reference ID

subRefType string

The sub reference type

isArchived boolean

Whether the page is archived

encryptStatus string

Encrypt status, none: not encrypted, encrypted: encrypted, readonly: readonly

canEdit boolean

Whether the page is editable

locked boolean

Whether the page is locked

]

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

errorData object

Error meta data for this request.

Example (from schema)

{
  "data": {
    "pages": [
      {
        "id": "string",
        "title": "string",
        "spaceID": "string",
        "createdTime": 0,
        "updatedTime": 0,
        "parentID": "string",
        "refType": "string",
        "refID": "string",
        "subRefType": "string",
        "isArchived": true,
        "encryptStatus": "string",
        "canEdit": true,
        "locked": true
      }
    ]
  },
  "result": "string",
  "errorCode": "string",
  "errorMsg": "string",
  "errorData": {}
}

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

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

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

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

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

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

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

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

Loading...