Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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]

...

VariableTypeDescription
systemCodeString

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.

userIdStringThe system userId to match against.
Success Response

If successful, you will be returned a UserResponse object containing the following:

PropertyTypeDescription
idIntegerThe Club OS unique user id.
firstNameStringThe first name of the user.
lastNameStringThe last name of the user.
clientsList<UserResponse>A list of clients assigned to the user (for staff only). This is used to populate the client selection feature.emailStringThe email of the user.
roleStringThe Club OS role of the user (Client, Trainer, ect..)
Failure Response

If your request fails, you will receive a Response object containing the following:

...