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. Codes can be either 'ABC' or 'OS'. |
| userId | String | The 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..) |
| 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. |