Skip to main content

`"listAccounts"`

JSON ADMIN `"listAccounts"` action lists all accounts that the logged-in account is authorized to see

The "listAccounts" action lists all accounts that the logged-in account is authorized to see. Includes roleName and roleDescription.

Request examples

{
  "api": "admin",
  "action": "listAccounts",
  "authToken": "replaceWithAuthTokenFromCreateSession"
}

Maximal

{
  "api": "admin",
  "action": "listAccounts",
  "params": {
    "partialNames": [
      "adm",
      "NewAccount"
    ]
  },
  "authToken": "replaceWithAuthTokenFromCreateSession",
  "requestId": "1"
}

Use the listAccounts API action to list all accounts that the logged-in account is authorized to see

listAccountslistAccountlist accountAPI actionJSON ADMIN APIjsonAction

Params

Table 1. account property summaries

Property	Description	Default	Type	Limits (inclusive)
partialNames	returns accounts with usernames that match at least part of one or more of the specified values	[]	array