How can we help?

Search for answers to your questions by entering keywords below, or look through our knowledge base.

  1. Club OS Help Center
  2. API
  3. API V1 Services

API V1 - User Services

Follow

Important Note: API V1 is no longer the recommended API when integrating with Club OS.  To build a new integration, please refer to our API v3 Documentation for the most up to date APIs and documentation.

Verify, add and update members, trainers, and salespeople.

Base URL Format

https://api.club-os.com/[serviceName]?clubLocationId=[clubLocationId]

Variable
Type
Description
serviceName String The name of the service you want to access.
clubLocationId Integer The Club OS unique id for the club location you wish to access. Club OS will provide these to you.

Available Services

Service Name
Description
/users Verify, add and update members, trainers, and salespeople.
/checkins Add member checkins.
 

 

 

GET /users

Verifies that the given userId exists in Club OS and you have access to it.  

GET https://api.club-os.com/users?clubLocationId=[clubLocationId]&userId=[userId]

Parameters

The following fields must be included as parameters in the URL of the request.

Variable
Type
Description
clubLocationId Integer The Club OS unique id for the club location you wish to access. Club OS will provide these to you.
userId Integer The Club OS unique id for the user you are requesting.
Response Message

The following message will be returned when the request succeeds.

Message Description
User was found The user was found and you have access to them.

 

POST /users

Add a user to the system.

POST https://api.club-os.com/users?clubLocationId=[clubLocationId]

Parameters

The following fields must be included as parameters in the URL of the request.

Variable
Type
Description
clubLocationId Integer The Club OS unique id for the club location you wish to access. Club OS will provide these to you.
Request Body

The following fields must be included in the body of the HTTP request as a valid JSON string.

Property
Type
Required
Default
Description
role String Y   One of 'member', 'trainer', 'salesperson', 'manager', or 'frontdesk'.
fullAccount Boolean Y false

Club OS has 2 types of member accounts, Full and Basic. Full means they get access to both nutrition and/or workout features based on the club's service plan.

false - Make the member a Basic account.

true - Make the member a Full account.
sendEmail Boolean Y false If true, sends a welcome email to the member if they are created successfully and an email address was sent.
trainerId Integer N   The Club OS unique id for the trainer of the user being added or updated.
salespersonId Integer N   The Club OS unique id for the salesperson of the user being added or updated (applies to members only).
templateUsername String N   The username of the template account that should be applied to the user (applies to members only).
localUserId String Y   Your systems unique id for the user.
firstName String Y   User first name.
lastName String N   User last name.
email String N   Email address of the user. This will also be the username for the Club OS account if no username if provided.
username String N   Username of the user. This will be used to login to the system.
password String N   Password for the account. If left blank, one will be auto-generated.
gender String Y   'M' for male, 'F' for female.
birthDate Date (M-d-YYYY) N   User date of birth.
joinDate Date (M-d-YYYY) N   The date the User joined the club.
guestPassStart Date (M-d-YYYY) N   The start date of the user's guest pass.
guestPassEnd Date (M-d-YYYY) N   The end date of the users's guest pass.
homePhone String N   User home phone number.
workPhone String N   User work phone number.
mobilePhone String N   User mobile phone number.
address1 String N   User address line 1.
address2 String N   User address line 2.
city String N   User full city.
state String N   User 2 letter state code, i.e. PA for Pennsylvania.
zip String N   User zip code.
Response Messages

One of the following messages will be returned when the request succeeds.

Message Description
Member Created Member account successfully created.
Member Found Member account exists in the system already.
Trainer Created Trainer account was successfully created.
Trainer Found Trainer account exists in the system already.
Salesperson Created Salesperson account successfully created.
Salesperson Found Salesperson account exists in the system already.

PUT /users

Update a users account type and deleted status. If the user has been previously deleted, they will be undeleted after a successful PUT request.

PUT https://api.club-os.com/users?clubLocationId=[clubLocationId]

Parameters

The following fields must be included as parameters in the URL of the request.

Variable
Type
Description
clubLocationId Integer The Club OS unique id for the club location you wish to access. Club OS will provide these to you.
Request Body

Any of the fields below may be included in the body of the HTTP request as a valid JSON string.  Only fields included in the request will be updated.  For example, if you only want to update the first and last name, the JSON should be { userId: "clubOsUserId", firstName: "newFirstName", lastName: "newLastName"}

Property
Type
Required
Default
Description
userId Integer Y   The Club OS unique id for the member to update.
firstName String N   User first name.
lastName String N   User last name.
email String N   Email address of the user. This will also be the username for the Club OS account. If left blank, the user will not be able to login to Club OS.
homePhone String N   User home phone number.
workPhone String N   User work phone number.
mobilePhone String N   User mobile phone number.
address1 String N   User address line 1.
address2 String N   User address line 2.
city String N   User full city.
state String N   User 2 letter state code, i.e. PA for Pennsylvania.
zip String N   User zip code.
fullAccount Boolean Y false

Club OS has 2 types of member accounts, Full and Basic. Full means they get access to both nutrition and/or workout features based on the club's service plan. This field only applies to member accounts.

false - Make the member a Basic account.

true - Make the member full account.
guestPassStart Date (M-d-YYYY) N   The start date of the user's guest pass. Only saved if present, i.e. NULL or "" value will not update the record in Club OS.
guestPassEnd Date (M-d-YYYY) N   The end date of the users's guest pass. Only saved if present, i.e. NULL or "" value will not update the record in Club OS.
joinDate Date (M-d-YYYY) N   The date the User joined the club.
Response Messages

One of the following messages will be returned when the request succeeds.

Message Description
<name> was made FULL The account was made FULL.
<name> was made BASIC The account was made BASIC.

DELETE /users

Delete a users account from Club OS.

DELETE https://api.club-os.com/users?clubLocationId=[clubLocationId]&userId=[userId]

Parameters

The following fields must be included as parameters in the URL of the request.

Variable
Type
Description
clubLocationId Integer The Club OS unique id for the club location you wish to access. Club OS will provide these to you.
userId Integer The Club OS unique id for the user you are deleting.
Response Messages

The following message will be returned when the request succeeds.

Message Description
<name> was deleted The account was made deleted.

 

 

POST /checkins

Add a checkin (when the member scans / checks in to the club) to Club OS.  Checkins are displayed on the members profile page and used in reporting.

POST https://api.club-os.com/checkins?clubLocationId=[clubLocationId]

Parameters

The following fields must be included as parameters in the URL of the request.

Variable
Type
Description
clubLocationId Integer The Club OS unique id for the club location you wish to access. Club OS will provide these to you.
Request Body

The following fields must be included in the body of the HTTP request as a valid JSON string.

Property
Type
Required
Default
Description
memberId Integer Y   The Club OS unique id for the member who checked in.
localCheckinId String Y   Your systems unique id for the checkin.
checkinTime Date (M-d-YYYY HH:mm:ss) Y   The date and time of the checkin. HH should be in military time i.e. 00-23.
Response Messages

One of the following messages will be returned when the request succeeds.

Message Description
Check-in Created Checkin successfully created.
Check-in Found Checkin already exists in the system with the given localCheckinId.
 
Was this article helpful?
0 out of 0 found this helpful

Comments