Get space detail by space ID

GET 
/wiki/spaces/:spaceID

History

Version	Changes
v6.2.16	Added in: v6.2.16

Get space detail by space ID.

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

Responses

200

Request is successful.

application/json

Schema

Schema

data

object

id string

The space ID

title string

The space name

description string

The space description

homePageID string

The homepage ID

createdTime integer

The createdTime of space

updatedTime integer

The updatedTime of space

creatorID string

The creator ID

isOpenPublic boolean

Whether the space is allowed to share publicly

isOpenShare boolean

Whether the space is allowed to share internally

isPin boolean

Whether the space is pinned

categoryID string

The category ID

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": {
    "id": "string",
    "title": "string",
    "description": "string",
    "homePageID": "string",
    "createdTime": 0,
    "updatedTime": 0,
    "creatorID": "string",
    "isOpenPublic": true,
    "isOpenShare": true,
    "isPin": true,
    "categoryID": "string"
  },
  "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...