cybozu.com 通用 API 文件

獲取群組

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

獲取群組

連結已複製

檢索組資訊。
一次最多可以檢索 100 個組。

有關匯出 CSV 檔的 API 的更多資訊，請參閱 匯出組 。

URL

連結已複製

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

HTTP 方法

連結已複製

GET

所需許可權

連結已複製

無

請求

連結已複製

參數
參數名稱 型 必須 說明
ids 陣列 自選 組ID清單
codes 是相互排斥的。
ids codes 如果同時省略 和 ，則最多可獲得100個組資訊。
codes 陣列 自選 群組代碼1
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

頁眉
1
2
3

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

有關請求頭的詳細資訊，請參閱 通用使用者 API 規範 。

回應

連結已複製

財產
屬性名稱 型 說明
groups 陣列 群組資訊
有關格式， 請參閱組類型 。
示例回應
 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 的請求
1
2

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