/emailmatch
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 |
|---|---|---|
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. |