スペースの情報を取得する

目次

スペースの情報を取得する

スペースの情報を取得します。

  • スペース機能を利用していない場合には、エラーが発生します。
  • ゲストスペース機能が無効の場合に、ゲストスペースの情報を取得しようとするとエラーが発生します。

URL

通常のスペース
https://sample.cybozu.com/k/v1/space.json
ゲストスペース
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/space.json

HTTPメソッド

GET

必要なアクセス権

  • スペースの閲覧権限
    非公開スペースの場合、スペースメンバーのみ実行可能です。

リクエスト

パラメーター
パラメーター名 必須 説明
id 数値または文字列 必須 情報を取得するスペースのスペースID
リクエストの例(URLにパラメーターを含める場合)
URL

https://sample.cybozu.com/k/v1/space.json?id=1

ヘッダー
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は kintone REST APIの共通仕様を参照してください。

リクエストの例 (リクエストボディにパラメーターを含める場合)
URL

https://sample.cybozu.com/k/v1/space.json

ヘッダー
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は kintone REST APIの共通仕様を参照してください。

ボディ
1
2
3
{
  "id": "1"
}

レスポンス

プロパティ
プロパティ名 説明
id 文字列 スペースID
name 文字列 スペース名
defaultThread 文字列 スペースが作成されたときに初期作成されたスレッドのスレッドID
1つのスレッドのみ使用するスペースの場合はこのスレッドのみ存在します。
isPrivate 真偽値 公開/非公開の区分
  • true:非公開スペース
  • false:公開スペース
creator オブジェクト スペースの作成者情報
creator.code 文字列 作成者のコード
停止中または削除済みユーザーの場合は、空文字列が返ります。
creator.name 文字列 作成者の名前
停止中または削除済みユーザーの場合は、空文字列が返ります。
modifier オブジェクト スペースの更新者情報
modifier.code 文字列 更新者のコード
停止中または削除済みユーザーの場合は、空文字列が返ります。
modifier.name 文字列 更新者の名前
停止中または削除済みユーザーの場合は、空文字列が返ります。
memberCount 文字列 スペースのメンバー数
coverType 文字列 スペースのカバー画像の種類
  • BLOB:アップロードしたファイル
  • PRESET:組込み画像
coverKey 文字列 スペースのカバー画像のキー文字列
coverUrl 文字列 スペースのカバー画像のURL
body 文字列 スペースの本文(HTML)
スペース本文のHTMLが空の場合nullが返ります。
ただし、一度でも本文を設定したことがあるスペースの場合、画面上では何も表示されていなくても、HTMLタグのみが設定されている可能性があります。その場合、それらの文字列が返ります。
useMultiThread 真偽値 「スペースのポータルと複数のスレッドを使用する」が有効のスペースかどうか
  • true:「スペースのポータルと複数のスレッドを使用する」が有効のスペース
  • false:1つのスレッドのみ使用するスペース
isGuest 真偽値 ゲストスペースかどうか
  • true:ゲストスペース
  • false:通常スペース
attachedApps 配列 スレッド内アプリのリスト
公開前のアプリは含みません。
設定完了していない項目も反映されません。
attachedApps[].threadId 文字列 スレッドID
attachedApps[].appId 文字列 アプリID
attachedApps[].code 文字列 アプリコード
指定されていない場合は空文字が返ります。
attachedApps[].name 文字列 アプリの名前
国際化に対応した結果が返ります。
attachedApps[].description 文字列 アプリの説明
国際化に対応した結果が返ります。
attachedApps[].createdAt 文字列 アプリの作成日時
attachedApps[].creator オブジェクト アプリの作成者情報
attachedApps[].creator.code 文字列 作成者のコード
停止中または削除済みユーザーの場合は、空文字列が返ります。
attachedApps[].creator.name 文字列 作成者の名前
停止中または削除済みユーザーの場合は、空文字列が返ります。
attachedApps[].modifiedAt 文字列 アプリの更新日時
attachedApps[].modifier オブジェクト アプリの更新者情報
attachedApps[].modifier.code 文字列 更新者のコード
停止中または削除済みユーザーの場合は、空文字列が返ります。
attachedApps[].modifier.name 文字列 更新者の名前
停止中または削除済みユーザーの場合は、空文字列が返ります。
fixedMember 真偽値 各ユーザーがスペースの退会/アンフォローすることを禁止するかどうか
  • true:禁止する
  • false:禁止しない
showAnnouncement 真偽値 「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「お知らせ」の表示状態
  • true:表示する
  • false:表示しない
1つのスレッドのみ使用するスペース/ゲストスペースでは 「null」が返ります。
showThreadList 真偽値 「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「スレッド一覧」の表示状態
  • true:表示する
  • false:表示しない
1つのスレッドのみ使用するスペース/ゲストスペースでは 「null」が返ります。
showAppList 真偽値 「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「アプリ一覧」の表示状態
  • true:表示する
  • false:表示しない
1つのスレッドのみ使用するスペース/ゲストスペースでは 「null」が返ります。
showMemberList 真偽値 「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「ピープル一覧」の表示状態
  • true:表示する
  • false:表示しない
1つのスレッドのみ使用するスペース/ゲストスペースでは 「null」が返ります。
showRelatedLinkList 真偽値 「スペースのポータルと複数のスレッドを使用する」が有効のスペースのポータルの「関連リンク一覧」の表示状態
  • true:表示する
  • false:表示しない
1つのスレッドのみ使用するスペース/ゲストスペースでは 「null」が返ります。
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
{
  "id": "1",
  "name": "全体連絡スペース",
  "defaultThread": "3",
  "isPrivate": true,
  "creator": {
    "code": "tanaka",
    "name": "田中太郎"
  },
  "modifier": {
    "code": "tanaka",
    "name": "田中太郎"
  },
  "memberCount": "10",
  "coverType": "PRESET",
  "coverKey": "GREEN",
  "coverUrl": "https://*******/green.jpg",
  "body": "<b>全体</b>のスペースです。",
  "useMultiThread": true,
  "showAnnouncement": true,
  "showThreadList": true,
  "showAppList": true,
  "showMemberList": true,
  "showRelatedLinkList": true,
  "isGuest": false,
  "fixedMember": false,
  "attachedApps": [
    {
      "threadId": "3",
      "appId": "1",
      "code": "TASK",
      "name": "タスク管理",
      "description": "タスクを管理するアプリです。",
      "createdAt": "2012-02-03T09:22:00Z",
      "creator": {
        "name": "佐藤昇",
        "code": "sato"
      },
      "modifiedAt": "2012-04-15T10:08:00Z",
      "modifier": {
        "name": "佐藤昇",
        "code": "sato"
      }
    },
    {
      "threadId": "3",
      "appId": "10",
      "code": "",
      "name": "アンケートフォーム",
      "description": "アンケートアプリです。",
      "createdAt": "2012-02-03T09:22:00Z",
      "creator": {
        "name": "佐藤昇",
        "code": "sato"
      },
      "modifiedAt": "2012-04-15T10:08:00Z",
      "modifier": {
        "name": "佐藤昇",
        "code": "sato"
      }
    },
    {
      "threadId": "3",
      "appId": "11",
      "code": "",
      "name": "日報",
      "description": "日報アプリです。",
      "createdAt": "2012-02-03T09:22:00Z",
      "creator": {
        "name": "加藤美咲",
        "code": "kato"
      },
      "modifiedAt": "2012-04-15T10:08:00Z",
      "modifier": {
        "name": "加藤美咲",
        "code": "kato"
      }
    }
  ]
}

サンプルコード

curlを使ったリクエスト
1
2
3
4
5
6
curl -X GET 'https://sample.cybozu.com/k/v1/space.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1
  }'
kintone REST APIリクエストを送信するAPIを使ったリクエスト
1
2
3
4
5
const body = {
  id: 1
};

await kintone.api(kintone.api.url('/k/v1/space.json', true), 'GET', body);