ClubReady Api

<back to all web services

GetAllUsersRequest

The following routes are available for this service:
GET/club/{StoreId}/Users/allGet all Users for club
GetAllUsersRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoChain ID
StoreIdqueryintegerYesStore ID
IncludeDeletedqueryboolNoInclude deleted users in result? (defaults to false)
PageSizequeryintNoMax number of records to include in the response.
PageNumberqueryintNoPage number to retrieve.
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
GetAllUsersRequestDto Parameters:
NameParameterData TypeRequiredDescription
IncludeDeletedformboolNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ChainIdformint?No
ApiKeyformstringNo
StoreIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"UserId":0,"Prospect":false,"Member":false,"DateAdded":"0001-01-01T00:00:00.0000000","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"}]