Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

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.

VariableTypeDescription
systemCodeString

The code of the system you wish to access. Codes can be either 'ABC' or 'OS'.

userIdStringThe userId to match against
Success Response

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

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.
  • No labels