ClubReady Api

UsersListRequest

The following routes are available for this service:
GET	/users	Get users list filtered by date

**UsersListRequest** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	No	IP address of the end user
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	No	StoreId OR ChainId is required
ChainId	query	integer	No	StoreId OR ChainId is required
ActivityDate	query	Date	Yes	Date to use for filter
ActivityOperator	query	String	No	The operator to use when comparing ActivityDate. Options are GT,EQ and LT for Greater Than, Equal and Less Than. Defaults to GT if not provided.
Segment	query	string	No	Filter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No
Version	query	string	No	Version 2 adds email and mobile phone to output

**UsersListRequestDto** Parameters:
Name	Parameter	Data Type	Required
Segment	form	string	No
ActivityDate	form	string	No
ActivityOperator	form	string	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /users HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml