GET api/users?emailFilter={emailFilter}&nameFilter={nameFilter}&groupID={groupID}&active={active}&activeAndInactive={activeAndInactive}&filterText={filterText}&filterBy={filterBy}&filterExact={filterExact}&customFields={customFields}&includeCreateDate={includeCreateDate}&includeGroups={includeGroups}
Returns a list of Users
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
emailFilter |
Only users that contain this value in their email address will be returned |
string |
None. |
nameFilter |
Only users that contain this value in their name will be returned |
string |
None. |
groupID |
Only return users who are a member of this group (Available to Admin Accounts Only) |
integer |
None. |
active |
Include only active users, set to false to include only non active users |
boolean |
None. |
activeAndInactive |
Includes active AND inactive users, and response will include each users active status (If this is set, 'active' setting will be ignored). |
boolean |
None. |
filterText |
The text you wish to filter for (used in conjunction with filterBy) |
string |
None. |
filterBy |
The field in which you wish to filter (used in conjunction with filterText) |
string |
None. |
filterExact |
If true the filterText/filterBy filtering performs an exact match, if false, it performs a 'contains' search. |
boolean |
None. |
customFields |
(Optional) user profile fields to include in the response. |
string |
None. |
includeCreateDate |
Include the date the user was added to the site. |
boolean |
None. |
includeGroups |
Include the groups the user is a member of. |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of Users
Collection of Dictionary of Object [key] and Object [value]Response Formats
application/json, text/json
Sample not available.