cybozu.com 共通 API 文件

獲取使用者

information

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

目錄

獲取使用者

連結已複製

獲取用戶資訊。

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

URL

連結已複製

https://sample.cybozu.com/v1/users.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/users.json?codes[0]=sato-noboru&codes[1]=kato-misaki

標頭

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

1
2
3

{
  "Authorization": "Bearer API_TOKEN"
}

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

回應

連結已複製

屬性
屬性名稱 類型 說明
users 陣列 使用者資訊清單
詳情請參閱以下頁面。
User型
排序順序users[].id 為升序。
示例回應
 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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

{
  "users": [
    {
      "id": "1",
      "code": "sato-noboru",
      "ctime": "2019-04-01T00:33:58Z",
      "mtime": "2023-03-31T02:11:11Z",
      "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": "n00012",
      "birthDate": "1985-09-19",
      "joinDate": "2010-04-01",
      "primaryOrganization": "9",
      "sortOrder": null,
      "customItemValues": [
        {
            "code": "boss",
            "value": ""
        }
      ]
    },
    {
      "id": "2",
      "code": "kato-misaki",
      "ctime": "2019-04-01T00:33:58Z",
      "mtime": "2023-03-31T02:11:11Z",
      "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": "kato-misaki@example.com",
      "callto": "",
      "url": "",
      "employeeNumber": "m00312",
      "birthDate": "1991-04-17",
      "joinDate": "2022-04-01",
      "primaryOrganization": "9",
      "sortOrder": null,
      "customItemValues": [
        {
          "code": "boss",
          "value": "1"
        }
      ]
    }
  ]
}

示例代碼

連結已複製

使用 curl 的請求

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

1
2

curl -X GET 'https://sample.cybozu.com/v1/users.json?codes%5B0%5D=sato-noboru&codes%5B1%5D=kato-misaki' \
  -H 'Authorization: Bearer API_TOKEN'

注意事項

連結已複製

若要獲取自訂項目，在添加項后，必須執行下列舉措之一，以重新保存使用者資訊：

限制事項

連結已複製

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