Skip to main content
Aria Knowledge Central


Retrieves every user for a given client.

For information on error messages generated by this API, see get_users_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
  include_archived_user boolean  

If set to true then the API will also return ‘Archived’ users. Default is "false."

Allowable Values

Value Definition
1 Return "Archived" users
true Return "Archived" users
0 Do not return "Archived" users
false Do not return "Archived" users

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
username string Login name of the user.
first_name string User first name.
last_name string User last name.
email string Email of the user.
roles array  
 role_no int Aria-assigned number of the role.
 client_role_id string Client-assigned identifier of the role.
status int

Status of the user.

Return Values

Return Value


-99 archived
-1 pending activation
0 locked
1 active
  • Was this article helpful?