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'. |
| userId | String | The userId to match against |
Response
One of the following messages will be returned when the request succeeds.
| Status | Message | Value | Description |
| true | User found | Club OS unique id. | The member was successfully found and you have access to them. |
| false | User not found | The invalid systemCode and userId | Your credentials were invalid. |