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

VariableTypeDescription
clubLocationIdString

The Club OS club location id for the user you are looking for.

emailStringThe email address used to lookup the user.
Success Response

If successful, you will be returned a List<UserResponse>, with each object containing the following:

PropertyTypeDescription
idIntegerThe Club OS unique user id.
firstNameStringThe first name of the user.
lastNameStringThe last name of the user.
emailStringThe email of the user.
roleStringThe Club OS role of the user (Client, Trainer, etc..)
hasWorkoutsBooleanIf the user has access to workouts.
hasNutritionBooleanIf the user has access to nutrition.
workoutGradeIntegerThe workout grade for the user (0-100+).
nutritionGradeIntegerThe nutrition grade for the user (0-100+).
workoutGoalIntegerThe goal number of workouts per week.
clientsList<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:

PropertyTypeDescription
statusBooleanWill always be false.
responsesResponseMessage[]An array of ResponseMessage objects describing the error.