# Clubfit Software API (BETA)

This API documentation provides technical information about integrating to Clubfit Software.  

 **PLEASE NOTE**

Clubfit utilizes Oauth2 for authentication and the header x-api-token for the authorisation. Both need to be used in the API calls. 

 We will provide you with your temporary credentials along with an API key per club. Please reach out to support if you do not have these. 

 <br>There are 2 API access plans currently available: 

**Basic Plan $20 per club per month (ex GST)** 

 1 000 000 requests per month 

**Advanced Plan $50 per club per month (ex GST)** 

 5 000 000 requests per month

Version: 1.0

## Servers

```
https://api.clubfit.net.au/v1
```

## Security

### OAuth2

Type: oauth2

### BasicAuth

Type: http
Scheme: basic

### ApiKeyAuth

Type: apiKey
In: header
Name: X-API-Key

## Download OpenAPI description

[Clubfit Software API (BETA)](https://developer.clubfitsoftware.com.au/_spec/openapi.yaml)

## Authentication

API authentication. This endpoint will create an access token that you can then use for subsequent API calls.

### Token

 - [POST /token](https://developer.clubfitsoftware.com.au/openapi/authentication/authenticationtoken.md): Retrieve access token

## Members

The member endpoints will return data relvant to member information.

### Information

 - [GET /members](https://developer.clubfitsoftware.com.au/openapi/members/memberdata.md): Retrieve member details including contact and membership information.

### Visits

 - [GET /members/attendance/visits](https://developer.clubfitsoftware.com.au/openapi/members/getmembervisits.md): Get member visits from a particular date. This does not include Creche, PT or Class visits.

### Payment history

 - [GET /members/payment/history](https://developer.clubfitsoftware.com.au/openapi/members/getmemberpaymenthistory.md): Retrieve member payment history transaction information.

### POS transactions

 - [GET /members/pos/transactions](https://developer.clubfitsoftware.com.au/openapi/members/getmemberpostransactions.md): Retrieve member POS transactions information including staff member, line items and payments made.

## Prospects

The prospect endpoints will return data relvant to prospect information.

### Information

 - [GET /prospects](https://developer.clubfitsoftware.com.au/openapi/prospects/prospectdata.md): Retrieve prospect details including contact and trial information.

## Financial

The financial endpoints will return data relvant to financial information.

### Gym disbursements

 - [GET /financial/disbursements](https://developer.clubfitsoftware.com.au/openapi/financial/getfinancialdisbursments.md): Disbursement payments made to your club

### Debt collection

 - [GET /financial/debtcollection](https://developer.clubfitsoftware.com.au/openapi/financial/getfinancialdebtcollection.md): Member details sent to debt collection