cybozu.com 共通 API 文件

獲取屬於某個群組的使用者

information

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

目錄

獲取屬於某個群組的使用者

連結已複製

獲取屬於該群組的使用者。

沒有用於匯出 CSV 檔案的 API。

URL

連結已複製

https://sample.cybozu.com/v1/group/users.json

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

無

請求

連結已複製

參數
參數名稱 類型 必須 說明
code 字串 必須 群組代碼
size 數值 可省略 要獲取的用戶數
您可以指定 1 到 100。如果省略，則設置為100。
offset 數值 可省略 從一開始就跳過的用戶數
您可以指定一個從 0 到無窮大的數位。
如果省略，則設置為0。
示例請求
URL

https://sample.cybozu.com/v1/group/users.json?code=Recruit2022

標頭
1
2
3

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

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

回應

連結已複製

屬性
屬性名稱 類型 說明
users 陣列 有關屬於該群組的用戶的資訊
詳情請參閱以下頁面。
User型
示例回應
 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

{
  "users": [
    {
      "id": "1",
      "code": "sato-noboru",
      "ctime": "2019-04-01T00:33:58Z",
      "mtime": "2023-03-31T04:37:39Z",
      "valid": true,
      "name": "佐藤 昇",
      "surName": "佐藤",
      "givenName": "昇",
      "surNameReading": "さとう",
      "givenNameReading": "のぼる",
      "localName": "",
      "localNameLocale": "ja",
      "timezone": "Asia/Tokyo",
      "locale": "ja",
      "description": "",
      "phone": "0000-000-0000",
      "mobilePhone": "090-000-0000",
      "extensionNumber": "",
      "email": "sato-noboru@example.com",
      "callto": "",
      "url": "",
      "employeeNumber": "",
      "birthDate": "1991-04-17",
      "joinDate": "2020-04-01",
      "primaryOrganization": "9",
      "sortOrder": null,
      "customItemValues": [
        {
          "code": "boss",
          "value": "2"
        }
      ]
    }
  ]
}

示例代碼

連結已複製

使用 curl 的請求
1
2

curl -X GET 'https://sample.cybozu.com/v1/group/users.json?code=Recruit2022' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='

限制事項

連結已複製

  • 無法獲取kintone訪客使用者。