Club OS
Updated :
Important Note: API V1 is no longer the recommended API when integrating with Club OS. To build a new integration, please refer to our API v3 Documentation for the most up to date APIs and documentation.
Available Services
|
Service Name
|
Description
|
|---|---|
| /access | Get a list of locations which your user has access to. |
| /emailmatch | Search for a club os user by email address. |
| /usermatch | Search for a club os user by their external ID. |
GET /access/locations
Gets the list of locations that your account can access.
GET https://api.club-os.com/access/locations
Success Response
If successful, you will be returned a Location objects containing the following:
| Property | Type | Description |
| id | Integer | The Club OS unique id for the location. |
| name | String | The name of the location. |
| systemId | String | The member management / billing system ID for the location. |
Failure Response
If your request fails, you will receive a Response object containing the following:
|
Property
|
Type
|
Description
|
|---|---|---|
| status | Boolean | Will always be false. |
| responses | ResponseMessage[] | An array of ResponseMessage objects describing the error. |
GET /access/services
Gets the list of service endpoints that your account can access.
GET https://api.club-os.com/access/services
Success Response
If successful, you will be returned a Strings containing the following:
| Property | Type | Description |
| Endpoint Name | String | The URL of the endpoint. |
Failure Response
If your request fails, you will receive a Response object containing the following:
|
Property
|
Type
|
Description
|
|---|---|---|
| status | Boolean | Will always be false. |
| responses | ResponseMessage[] | An array of ResponseMessage objects describing the error. |
GET /emailmatch
Gets the Club OS unique id for one or more users given an email address.
GET https://api.club-os.com/emailmatch?clubLocationId=[clubLocationId]&email=[email]
Parameters
The following fields must be included as parameters in the URL of the request.
|
Variable
|
Type
|
Description
|
|---|---|---|
| clubLocationId | String |
The Club OS club location id for the user you are looking for. |
| String | The email address used to lookup the user. |
Success Response
If successful, you will be returned a List<UserResponse>, with each object containing the following:
| Property | Type | Description |
| id | Integer | The Club OS unique user id. |
| firstName | String | The first name of the user. |
| lastName | String | The last name of the user. |
| String | The email of the user. | |
| role | String | The Club OS role of the user (Client, Trainer, etc..) |
| hasWorkouts | Boolean | If the user has access to workouts. |
| hasNutrition | Boolean | If the user has access to nutrition. |
| workoutGrade | Integer | The workout grade for the user (0-100+). |
| nutritionGrade | Integer | The nutrition grade for the user (0-100+). |
| workoutGoal | Integer | The goal number of workouts per week. |
| clients | List<UserResponse> | A list of clients assigned to the user (for staff only). This is used to populate the client selection feature. |
Failure Response
If your request fails, you will receive a Response object containing the following:
|
Property
|
Type
|
Description
|
|---|---|---|
| status | Boolean | Will always be false. |
| responses | ResponseMessage[] | An array of ResponseMessage objects describing the error. |
GET /usermatch
Gets the Club OS unique id for a member given the userId from one of Club OS's integrated systems.
GET https://api.club-os.com/usermatch?systemCode[systemCode]&userId=[userId]
Parameters
The following fields must be included as parameters in the URL of the request.
|
Variable
|
Type
|
Description
|
|---|---|---|
| systemCode | String |
The code of the system you wish to access. Get these codes from your Club OS developer contact. |
| userId | String | The system userId to match against. |
Success Response
If successful, you will be returned a UserResponse object containing the following:
| Property | Type | Description |
| id | Integer | The Club OS unique user id. |
| firstName | String | The first name of the user. |
| lastName | String | The last name of the user. |
| String | The email of the user. | |
| role | String | The Club OS role of the user (Client, Trainer, ect..) |
Failure Response
If your request fails, you will receive a Response object containing the following:
|
Property
|
Type
|
Description
|
|---|---|---|
| status | Boolean | Will always be false. |
| responses | ResponseMessage[] | An array of ResponseMessage objects describing the error. |
Comments