ClubReady Api

<back to all web services

UsersListRequest

The following routes are available for this service:
GET/usersGet users list filtered by date
UsersListRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerNoStoreId OR ChainId is required
ChainIdqueryintegerNoStoreId OR ChainId is required
ActivityDatequeryDateYesDate to use for filter
ActivityOperatorqueryStringNoThe 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.
SegmentquerystringNoFilter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
VersionquerystringNoVersion 2 adds email and mobile phone to output
UsersListRequestDto Parameters:
NameParameterData TypeRequiredDescription
SegmentformstringNo
ActivityDateformstringNo
ActivityOperatorformstringNo
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 .xml suffix or ?format=xml

HTTP + 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