ClubReady Api

<back to all web services

GetProspectTypesRequest

The following routes are available for this service:
GET/club/lead-typesList of prospect types.
GetProspectTypesRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
ChainIdqueryintegerNoEither StoreId or ChainId is required
StoreIdqueryintegerNoEither StoreId or ChainId is required
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
GetProspectTypesResponse Parameters:
NameParameterData TypeRequiredDescription
LeadTypesformList<ApiGenericType>No
GetProspectTypesResponseDto Parameters:
NameParameterData TypeRequiredDescription
LeadTypesformList<ApiGenericType>No
ApiGenericType Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
StoreIdformint?No
ChainIdformint?No

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

HTTP + CSV

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

GET /club/lead-types HTTP/1.1 
Host: clubready.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"LeadTypes":[{"Id":0,"Name":"String","StoreId":0,"ChainId":0}]}