ユーザーを取得する
ユーザー情報を取得します。
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トークンを利用する場合、指定するスコープにかかわらず実行可能です。
|
|
リクエストヘッダーの詳細は次のページを参照してください。
User APIの共通仕様
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
users | 配列 | ユーザ情報の一覧 詳細は次のページを参照してください。 User型 並び順は、 users[].id の昇順です。 |
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行
|
|
注意事項
カスタマイズ項目を取得するには、項目を追加した後、次のいずれかの操作でユーザー情報を保存し直す必要があります。
- cybozu.com共通管理の「ユーザー情報の変更」画面で「ユーザー情報を変更」ボタンを押します。
- 「ユーザーを更新する」APIを使用して、ユーザーを更新します。
ユーザーを更新する - CSVを使用して、ユーザーの情報をインポートし直します。
- 手動でインポートする場合は、次のヘルプページを参考にしてください。
ファイルを使ってユーザーや組織などを追加または変更する - APIを使用してインポートする場合は、次のドキュメントを参考にしてください。
ユーザー情報をインポートする
- 手動でインポートする場合は、次のヘルプページを参考にしてください。
制限事項
- kintoneのゲストユーザーは取得できません。