開発者向け機能:API:ユーザ操作:ユーザ取得(全て)
## 概要
APIを使用してユーザーのレコードを取得する事ができます。
## 事前準備
APIの操作を行う前に[APIキーの作成](/manual/api-key)を実施してください。
## 対応バージョン
#### ApiGetMailAddresses
1. プリザンター 1.3.16.0 以降
## リクエスト
下記のリクエスト形式で、jsonデータを送信します。
|設定項目|値|
|:--|:--|
|HTTPメソッド|POST|
|Content-Type |application/json|
|文字コード|UTF-8|
|URL|http://{サーバー名}/api/users/get (※1)|
|Body|以下のjsonデータを参考のこと|
(※1){サーバー名}の部分は、適宜、環境に合わせて編集してください。
pleasanter.netの場合は以下の形式になります。
https\://pleasanter.net/fs/api/users/get
##### JSON
```
{
"ApiVersion": 1.1,
"ApiKey": "610saf33fg52D3Sas2f7g32...",
"View":{
"ApiGetMailAddresses":true
}
}
```
※ ApiGetMailAddress はオプショナル(必須でない項目)です。省略時は false が指定されます。true を指定した場合、次の例のようにメールアドレスが配列で応答に含まれます。
## レスポンス
下記の形式のjsonデータが返却されます。 データのレイアウトは[こちら](/manual/api-user)を参照してください(パスワードは取得できません)。
### (a)テナント管理者の場合
##### JSON
```
{
"StatusCode": 200,
"Response": {
"Offset": 0,
"PageSize": 200,
"TotalCount": 1,
"Data": [
{
"TenantId": 12345,
"UserId": 12345,
"Ver": 1,
"LoginId": "",
"GlobalId": "",
"Name": "",
"UserCode": "",
"LastName": "",
"FirstName": "",
"Birthday": "",
"Gender": "",
"Language": "ja",
"TimeZone": "Tokyo Standard Time",
"DeptCode": "",
"DeptId": 0,
"FirstAndLastNameOrder": 1,
"Body": "",
"LastLoginTime": "",
"PasswordExpirationTime": "1899-12-30T00:00:00",
"PasswordChangeTime": "",
"NumberOfLogins": "",
"NumberOfDenial": "",
"TenantManager": ,
"ServiceManager": ,
"Disabled": false,
"Lockout": false,
"LockoutCounter": 0,
"Developer": false,
"UserSettings": "{\"DisableStartGuide\":true}",
"LdapSearchRoot": "",
"SynchronizedTime": "1899-12-30T00:00:00",
"Comments": "[]",
"Creator": 2,
"Updator": 1,
"CreatedTime": "",
"UpdatedTime": "",
"MailAddresses": [
"webmaster@example.com",
"info@example.com"
],
"ApiVersion": 1.1,
"ClassHash": {},
"NumHash": {},
"DateHash": {},
"DescriptionHash": {},
"CheckHash": {},
"AttachmentsHash": {}
}
]
}
}
```
### (b)テナント管理者以外の場合
##### JSON
```
{
"StatusCode": 200,
"Response": {
"Offset": 0,
"PageSize": 200,
"TotalCount": 1,
"Data": [
{
"TenantId": 12345,
"UserId": 12345,
"Ver": 1,
"LoginId": "",
"GlobalId": "",
"Name": "",
"UserCode": "",
"LastName": "",
"FirstName": "",
"Birthday": "1899-12-30T00:00:00",
"Gender": "",
"Language": "ja",
"TimeZone": "Tokyo Standard Time",
"DeptCode": "",
"DeptId": 0,
"FirstAndLastNameOrder": 2,
"Body": "",
"ServiceManager": false,
"Developer": false,
"UserSettings": "{}",
"LdapSearchRoot": "",
"SynchronizedTime": "1899-12-30T00:00:00",
"Comments": "[]",
"Creator": 1,
"Updator": 4,
"CreatedTime": "",
"UpdatedTime": "",
"MailAddresses": [
"webmaster@example.com",
"info@example.com"
],
"ApiVersion": 1.1,
"ClassHash": {},
"NumHash": {},
"DateHash": {},
"DescriptionHash": {},
"CheckHash": {},
"AttachmentsHash": {}
}
]
}
}
```
## エラー時の確認事項
[・API使用時の注意点やエラーが発生する場合の確認事項](/manual/faq-api)
[・FAQ:変更後の設定ファイルやAPIリクエスト(JSON形式)が正しく認識されない場合の確認事項](/manual/faq-json-format)
## 仕様変更について
**※ 2018年11月よりAPIの仕様が一部変更となりました。**
- URLの形式が '/pleasanter/api_items/xxxx' から '/pleasanter/api/items/xxxx' に変更されました。
- Content-Type の指定が'application/x-www-form-urlencoded' から 'application/json'に変更されました。