get-user-list.md

Get Account User List

{% swagger baseUrl="[PlatformAddress]/api/1.0/" path="account?action=getUserList" method="post" summary="Get User List" %} {% swagger-description %} Get User List will respond with a list of users based on the filter parameters {% endswagger-description %}

{% swagger-parameter name="perPage" type="integer" in="path" %} The number of events to get in a single api call {% endswagger-parameter %}

{% swagger-parameter name="start" type="integer" in="path" %} The starting result of the page. Note this is zero based (i.e. sending start = 0 will start from the first result.) {% endswagger-parameter %}

{% swagger-response status="200" description="" %}

{% endswagger-response %} {% endswagger %}

Additional Filter Properties

Property	Description	Type
venueId	Filter by specific Venue	integer

Returns

Property	Description
id	The unique identifier for the user
salutation	The salutation of the user.
firstName	The first name of the user.
middleName	The middle name of the user.
lastName	The last name of the user.
email	The user’s email address
phone	The user’s mobile number
phoneMobile	The user’s phone number
currentStatus	The current status of the user. See Current Status
userType	The type of the user. See User Types.
groupId	The id of the group to which the user belongs
lastLoginDate	The date & time the user was last logged in.
createdDate	The date & time the resource was created
modifiedDate	'The date & time the resource was last modified

User Current Status

#	Description
1	Active
2	Inactive

User Types

#	Description
1	Normal
2	Abstract Reviewer
3	Event Client
4	API Third Party User
5	Meeting Booker

The result from this call will be a collection of all the users. This call also accepts the pagination and filter properties.