獲取空間使用情況

kintone API

獲取空間使用情況

連結已複製

此 API 僅適用於 Wide 版。
什麼是擴充版（Wide Course）？

獲取空間使用情況清單。

HTTP 方法	GET
URL	https://sample.cybozu.com/k/v1/spaces/statistics.json
認證	密碼驗證 , 會話認證
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": "営業部",
      "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文件

獲取空間使用情況

目錄

請求參數

應答屬性

所需存取權限

範例

限制事項