cybozu.com 共通 API ドキュメント

ユーザーを取得する

目次

ユーザーを取得する

ユーザー情報を取得します。

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

ヘッダー
1
2
3

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

リクエストヘッダーの詳細は User API の共通仕様 を参照してください。

レスポンス

プロパティ
プロパティ名 型 説明
user 配列 ユーザ情報の一覧
詳細は 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 を使ったリクエスト
1
2

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

制限事項

  • kintone のゲストユーザーは取得できません。