ApiKey Setup
In order to access the ClubReady API, you will need an ‘API Key’ configured.
Please email support@clubready.com to request more information and obtain an API Key. You will also need to sign an agreement with ClubReady.
Find your ClubReady ID
- Log in to your ClubReady account.
- Click on your profile image in the top right.
- A number is shown below your picture icon, e.g. “1234-56789012”. The first 4 digits are your ClubReady ID so “1234” in this example.
Connector Setup
The Connector can be installed using the credentials obtained in the above steps:
- API Key:
your_api_key - Store ID:
your_store_id - Chain ID:
your_chain_key
API terms
A list of some of the basic terms used within the ClubReady API.
- Chain/Corp – A corporate entity that typically will have more than one Store/Club in ClubReady.
- Store – a single Location (club) within the ClubReady system.
- Prospect/Lead – a User in the ClubReady system that is not yet buying services (customer) or does not yet have a membership (member).
- Service – a one-on-one activity between a staff person (Trainer/coach) and a customer, typically referred to as Personal Training.
- Class – any activity between a staff person (Trainer/coach) and more than one customer. Small Group, and Group-X.
- Staff Types – a “role” that Staff members are assigned to through the administrative interface in ClubReady in which you can assign permissions.
- Prospect Type – a way to categorize Leads in ClubReady. Based on a ProspectTypeId, a Lead can be pushed through automated work flows for marketing and sales actions/tasks.