Getting List Information

You can get a list of accounts.

Request Interface

HTTP Request

GET /accounts/definition

Parameter

There is no individual parameter for this request.

For details on common request parameters for Site API, refer toCommon Parameter

Response Interface

If the request is processed successfully, the following response is returned in JSON format.

{
  "limit": 10000,
  "totalSize": 1,
  "fetchSize": 1,
  "startIndex": 0,
  "maxResults": 30,
  "accounts": [
    {
      "id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "mailAddress": "sample@example.com",
      "statusCode": 0,
      "isVerifiedMailAddress": true,
      "passwordValidityPeriod": 0,
      "ipFilterGroupName": null,
      "memo": "xxxxxxxxxxxxxxxxxxxxxx"
    }
  ]
}

Property Name

Value

Description

limit

integer

The maximum number of accounts settings that can be registered. (Fixed to 10000)

totalSize

integer

The total number of data.

fetchSize

integer

The number of the obtained data.

startIndex

integer

Index of the first row of a data to retrieve.

maxResults

integer

The maximum number of indexes included in a response data.
accounts array Object array of the account settings.

id

string

ID of the registered account.

mailAddress

string

Email address.
statusCode number Status code of the account. (0: New, 1: In use, 2: Changing password management method, 3: Changing email address)

isVerifiedMailAddress

boolean

Whether the email address is verified or not. True if it is verified.

passwordValidityPeriod

number

Password validity period. The unit is days.

ipFilterGroupName

string

IP filter group name that is used to restrict access based on source IP address.

memo

string

Note for the account.

Examples

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    try {
        URL url = new URL(host + "/api/v2/accounts/definition");
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        connection.setRequestMethod("GET");
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        try (BufferedReader reader = 
		new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
            String line;
            while((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    } catch (IOException ex) {
        // error
    }
}

// load jquery 
var host = 'https://www.webconnect.hulft.com';
var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
$.ajax({
  type: 'GET',
  url: host + '/api/v2/accounts/definition',
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});