GET /usermatch
Gets the Club OS unique id for a member given the userId from one of Club OS's integrated systems. Useful to do single sign-on validation.
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'Get these codes from your Club OS developer contact. |
| userId | String | The system userId to match against. |
Success Response
One of the following messages If successful, you will be returned when the request succeeds.
...
a UserResponse object containing the following:
| Property | Type | Description | |||||
| trueid | User foundInteger | The Club OS unique user id. | |||||
| firstName | String | The first name of the user. | The member was successfully found and you have access to them. | false | User not found | The invalid systemCode and userId | Your credentials were invalid |
| 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. |