API

The myClubhouse API allows you to pull information from myClubhouse to an external source. This can be used to display information in your own format.

Instructions

1. Sign in to myClubhouse.

2. Go to your name > My Profile.

   Open

   

3. Scroll down to the “API Access” section.

   Open

   

4. Click “Create Token”.

   Open

   

5. Complete the wizard:

   Open

   

   1. Name: A name for the API Token.

   2. Accessible APIs: Select all or specific APIs that this Token can access.

   3. Expiry Date: Set a date for the API Token to expire, if left blank, the Token will not expire.

   4. Enabled: Set this to “Yes” so the API connection works.

   5. OK: Once you are happy with the details, click “OK” to generate the token.

6. Use your token that has been generated to implement the API.

Open

There is a link to the API documentation in the introduction at the start of the API Access section. This will help you to see the format that information pulled from myClubhouse will be delivered in.

Open

Tips

When creating the query string to the API it is worth noting that it is the same format as the one used in the Member Directory (or a similar myClubhouse table page, depending on which part of the API you are using). So the best way is to set up the Member Directory as you want it and then copy the filter part of the query string from the URL to use in the API call.

Any predefined Views you set up in the Member Directory (or similar) will also be available for you to reference in the API call. The user who has the API Access Token must have access to the View for it to work. Learn more about Views in this guide: Views

Related articles