ユーザーを取得する

固定リンクがコピーされました

ユーザーを取得する

固定リンクがコピーされました

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

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'

注意事項

固定リンクがコピーされました

カスタマイズ項目を取得するには、項目を追加した後、次のいずれかの操作でユーザー情報を保存し直す必要があります。

cybozu.com共通管理の「ユーザー情報の変更」画面で「ユーザー情報を変更」ボタンを押します。
「ユーザーを更新する」APIを使用して、ユーザーを更新します。
ユーザーを更新する
CSVを使用して、ユーザーの情報をインポートし直します。
- 手動でインポートする場合は、次のヘルプページを参考にしてください。
  ファイルを使ってユーザーや組織などを追加または変更する
- APIを使用してインポートする場合は、次のドキュメントを参考にしてください。
  ユーザー情報をインポートする

制限事項

固定リンクがコピーされました

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

共通管理API

共通管理 APIドキュメント

ユーザーを取得する

目次

ユーザーを取得する

URL

HTTPメソッド

必要なアクセス権

リクエスト

パラメーター

リクエストの例

URL

ヘッダー

レスポンス

プロパティ

レスポンスの例

サンプルコード

curlを使ったリクエスト

注意事項

制限事項

公式コミュニティ

この記事に関連する過去の質問