ClubReady Api

GetAllUsersRequest

The following routes are available for this service:
GET	/club/{StoreId}/Users/all	Get all Users for club

**GetAllUsersRequest** 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
ChainId	query	integer	No	Chain ID
StoreId	query	integer	Yes	Store ID
IncludeDeleted	query	bool	No	Include deleted users in result? (defaults to false)
PageSize	query	int	No	Max number of records to include in the response.
PageNumber	query	int	No	Page number to retrieve.
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**GetAllUsersRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
IncludeDeleted	form	bool	No

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

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

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

HTTP + JSV

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

GET /club/{StoreId}/Users/all HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		UserId: 0,
		Prospect: False,
		Member: False,
		DateAdded: 0001-01-01,
		Email: String,
		FirstName: String,
		LastName: String,
		StoreId: 0,
		Username: String,
		Address: String,
		City: String,
		State: String,
		Zip: String,
		Barcode: String,
		Phone: String,
		CellPhone: String,
		ExternalUserId: String,
		ProspectTypeName: String,
		DateOfBirth: String,
		MemberSinceDate: String,
		MembershipExpiresDate: String,
		MembershipEndedDate: String,
		EmailOptOut: False,
		SmsOptOut: False,
		SmsOptIn: False,
		ReferralTypeId: 0,
		ReferralTypeName: String
	}
]