スペースの使用状況を取得する

kintone API

スペースの使用状況を取得する

固定リンクがコピーされました

このAPIはワイドコースでのみ利用できます。
ワイドコースとは

スペースの使用状況の一覧を取得します。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/spaces/statistics.json
認証	パスワード認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

固定リンクがコピーされました

パラメーター名	型	必須	説明
offset	数値または文字列	省略可	取得するスペースの先頭からスキップする数省略すると0が設定されます。
limit	数値または文字列	省略可	取得する件数 1から100までの整数を指定できます。省略すると100が設定されます。

レスポンスプロパティ

固定リンクがコピーされました

プロパティ名	型	説明
spaces	配列	スペースの使用状況の一覧取得できるスペース情報は、APIを実行するユーザーの権限によって異なります。 kintoneシステム管理者：すべてのスペース通常のユーザー：公開スペースと参加中のスペース
spaces[].id	数値または文字列	スペースID
spaces[].name	文字列	スペース名
spaces[].administratorCount	数値または文字列	スペースの管理者の数
spaces[].memberCount	数値または文字列	スペースに所属するメンバーの数
spaces[].isPrivate	真偽値	スペースが非公開かどうか `true`：非公開スペース `false`：公開スペース
spaces[].isGuest	真偽値	ゲストスペースかどうか `true`：ゲストスペース `false`：通常のスペース
spaces[].creator	オブジェクト	スペースの作成者の情報
spaces[].creator.code	文字列	作成者のログイン名停止／削除済みユーザーの場合でも取得できます。
spaces[].creator.name	文字列	作成者の表示名停止／削除済みユーザーの場合でも取得できます。
spaces[].createdAt	文字列	スペースの作成日時
spaces[].modifier	オブジェクト	スペース設定の最終更新者の情報
spaces[].modifier.code	文字列	更新者のログイン名停止／削除済みユーザーの場合でも取得できます。
spaces[].modifier.name	文字列	更新者の表示名停止／削除済みユーザーの場合でも取得できます。
spaces[].modifiedAt	文字列	スペース設定の最終更新日時

必要なアクセス権

固定リンクがコピーされました

なし

サンプル

固定リンクがコピーされました

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/spaces/statistics.json?offset=0&limit=1

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/spaces/statistics.json

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

リクエストボディ

1
2
3
4


{
  "offset": 0,
  "limit": 1
}

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


{
  "spaces": [
    {
      "id": "1",
      "name": "第1営業部",
      "administratorCount": "2",
      "memberCount": "10",
      "isPrivate": true,
      "isGuest": false,
      "creator": {
        "code": "sato-noboru",
        "name": "Sato Noboru"
      },
      "createdAt": "2023-12-04T05:45:36.000Z",
      "modifier": {
        "code": "sato-noboru",
        "name": "Sato Noboru"
      },
      "modifiedAt": "2023-12-04T05:45:36.000Z"
    }
  ]
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5


const body = {
  limit: 1
};

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

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/spaces/statistics.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "limit": 1
  }'

制限事項

固定リンクがコピーされました

一度に取得できるスペース数は、100件までです。
ゲストユーザーは実行できません。

kintone API

kintone APIドキュメント

スペースの使用状況を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

制限事項