Users

Retrieve users.

https://<servername>:8443/api/user

Return value	Type	Description
Id	Integer	User record ID
adminProfile	String	User's admin profile
address	String	User's street address
city	String	User's city
email	String	Email address
firstName	String	First name
lastName	String	Last name
mobileNumber	String	Mobile phone number
mobileProvider	String	Mobile phone service provider
phone	String	Phone number
role	String	User's role
type	String	User Record Type (possible values: User or Administrative)
userId	String	User name
zipCode	String	User's zip code

Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X GET https://<servername>:8443/api/user?lastName=Howard

Example XML format

<userSearchResult>

<status>success</status>

<limit>1</limit>

<nextOffset>0</nextOffset>

<offset>0</offset>

<total>1</total>

<users>

<user>

<id>32</id>

<address>123 Main Str</address>

<city>Concord</city>

<email>Shemp@example.com</email>

<firstName>Shemp</firstName>

<lastName>Howard</lastName>

<mobilePhone>555-555-6789</mobilePhone>

<mobileProvider>AT&amp;T</mobileProvider>

<phone>555-555-1234</phone>

<role>Employee</role>

<state>NH</state>

<type>User</type>

<userId>Shemp</userId>

<zipCode>12345</zipCode>

<notes>the quick brown fox</notes>

</user>

</users>

</userSearchResult>