取得群組

連結已複製

取得群組

連結已複製

取得組資訊。
一次最多可以取得 100 個組。

有關導出CSV檔的API的更多資訊，請參閱以下頁面。
匯出組資訊

URL

連結已複製

https://sample.cybozu.com/v1/groups.json

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

無

請求

連結已複製

參數

參數名稱	類型	必須	說明
ids	陣列	可省略	群組ID清單 `codes` 是相互排斥的。如果同時省略`ids` 和`codes` ，則最多可獲得100個組資訊。
codes	陣列	可省略	群組代碼清單 `ids` 是相互排斥的。如果同時省略`ids` 和`codes` ，則最多可獲得100個組資訊。
size	數值	可省略	要取得的組數您可以指定 1 到 100。如果省略，則設定為100。
offset	數值	可省略	要從要取得的組的開頭跳過的數位您可以指定一個從 0 到無窮大的數位。如果省略，則設定為0。

示例請求

URL

https://sample.cybozu.com/v1/groups.json?codes[0]=Recruit2022&codes[1]=Recruit2023

標頭

使用API權杖時，不管哪個級別的權限範圍，都可以執行。

1
2
3


{
  "Authorization": "Bearer API_TOKEN"
}

有關請求頭的更多資訊，請參閱以下頁面。
User API通用規範

回應

連結已複製

屬性

屬性名稱	類型	說明
groups	陣列	群組資訊有關說明，請參閱以下頁面。 Group型

示例回應

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


{
  "groups": [
    {
      "id": "1",
      "code": "Recruit2022",
      "name": "2022年招聘專案",
      "description": "2022年招聘專案"
    },
    {
      "id": "2",
      "code": "Recruit2023",
      "name": "2023年招聘專案",
      "description": "2023年招聘專案"
    }
  ]
}

範例代碼

連結已複製

使用curl的請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

1
2


curl -X GET 'https://sample.cybozu.com/v1/groups.json?codes%5B0%5D=Recruit2022&codes%5B1%5D=Recruit2023' \
  -H 'Authorization: Bearer API_TOKEN'

共通管理API

cybozu.com 共通 API 文件

取得群組

目錄

取得群組

URL

HTTP 方法

所需存取權限

請求

參數

示例請求

URL

標頭

回應

屬性

示例回應

範例代碼

使用curl的請求