ClubReady Api

<back to all web services

SearchUsersRequest

The following routes are available for this service:
GET/users/findFind a member.
SearchUsersRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
FirstNamequerystringNoFilter by First Name
LastNamequerystringNoFilter by Last Name
StoreIdqueryintegerNoStoreId OR ChainId is required
ChainIdquerystringNoStoreId OR ChainId is required
BarcodequerystringNoFilter by barcode
EmailquerystringNoFilter by Email Address
PhonequerystringNoFilter by Phone Number
UserTypequeryintegerNoFilter by ClubReady User Type
PagequeryintegerNoPage of users to retrieve. Pulls back 100 users per page.
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
SearchUsersRequestDto Parameters:
NameParameterData TypeRequiredDescription
BarcodeformstringNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
PhoneformstringNo
UserTypeformint?No
Pageformint?No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?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 /users/find HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv