How can we help?

Introduction

The Club OS API v 2.0 provides endpoints for accessing the Club OS Calendar, Agreements, Leads, Follow-Ups and KPIs.  Email support@club-os.com to setup an account and receive your username and password.

Authentication

• Authentication URL: https://api2.club-os.com/authenticate?username={username}&password={password}
• Response back will be {"token":"{token}"}
• A token is good for 24 hours
• Each request to the API after authentication must include this header with every request: "Authorization: {token}"

Documentation

• General API v2 Endpoints: https://s3.amazonaws.com/clubos-docs/api/index.html 
• Training Management Calendar Endpoints: https://s3.amazonaws.com/clubos-docs/api/cal/index.html

Additional Information

Paging 

• A max of 1,000 results are returned per request.
• To get more than 1,000 results, you will need to use the offset parameter. Example: offset=2000