Get Space
Gets information of a Space.
Method | GET |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/space.json |
URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/space.json |
Authentication | Password Authentication, Session Authentication |
Content-Type | application/json (not needed if specifying the query with a query string) |
Contents
Permissions
For private spaces, the user must be a member of the Space.
Request Parameters
Parameter | Value | Required | Description |
---|---|---|---|
id | Integer or String | Yes | The Space ID. The Space ID can be found in the URL of the Space. A Space with the URL of https://{domainname}.kintone.com/k/#/space/111 has a Space ID of 111. |
Sample Request
JavaScript (using Kintone REST API Request)
|
|
XMLHttpRequest
|
|
Response Parameters
Parameter | Type | Description |
---|---|---|
id | String | The Space ID. |
name | String | The name of the Space |
defaultThread | String | The Thread ID of the default thread that was created when the Space was made. |
isPrivate | Boolean | The "Private" settings of the Space. true: The Space is private. false: The Space is not private. |
creator | Object | An object containing information of the creator of the Space. |
creator.code | String | The code (log in name) of the creator. An empty string is returned for inactive or deleted users. |
creator.name | String | The display name of the creator. An empty string is returned for inactive or deleted users. |
modifier | Object | An object containing information of the updater of the Space. |
modifier.code | String | The code (log in name) of the updater. An empty string is returned for inactive or deleted users. |
modifier.name | String | The display name of the updater. An empty string is returned for inactive or deleted users. |
memberCount | String | The number of members of the Space. |
coverType | String | The image type of the Cover Photo. BLOB: An uploaded image. PRESET: A preset image. |
coverKey | String | The key of the Cover Photo. |
coverUrl | String | The URL of the Cover Photo. |
body | String | The HTML of the Space body. |
useMultiThread | Boolean | The "Enable multiple threads." setting. true: The Space is a Multi-threaded Space. false: The Space is a Single-threaded Space. |
isGuest | Boolean | The Guest Space setting. true: The Space is a Guest Space. false: The Space is not a Guest Space. |
attachedApps | Array | A list of Apps that are in the thread. This does not include Apps that are not live yet. |
attachedApps[].threadId | String | The Thread ID of the thread that the App was created in. Apps that are created inside Spaces using the GUI will be automatically allocated to the default Thread. |
attachedApps[].appId | String | The App ID. |
attachedApps[].code | String | The App Code of the App. An empty string is returned if an App Code is not set in the App's settings. |
attachedApps[].name | String | The name of the App. If the App has localization settings, the localized name will be returned. |
attachedApps[].description | String | The description of the App. If the App has localization settings, the localized description will be returned. |
attachedApps[].createdAt | String | The date of when the App was created. |
attachedApps[].creator | Object | The information of the user who created the App. |
attachedApps[].creator.code | String | The code (log in name) of the creator. An empty string is returned for inactive users and deleted users. |
attachedApps[].creator.name | String | The display name of the creator. An empty string is returned for inactive users and deleted users. |
attachedApps[].modifiedAt | String | The date of when the App was last updated. |
attachedApps[].modifier | Object | The information of the user who last updated the App. |
attachedApps[].modifier.code | String | The code (log in name) of the last updater. An empty string is returned for inactive users and deleted users. |
attachedApps[].modifier.name | String | The display name of the last updater. An empty string is returned for inactive users and deleted users. |
fixedMember | Boolean | The "Block users from joining or leaving the space and following or unfollowing the threads." setting. true: Users cannot join/leave the Space or follow/unfollow threads. false: Users can join/leave the Space and follow/unfollow threads. |
Sample Response
|
|
Limitations
- If the Space or Guest Space feature is turned off, an error will be returned.