# Clubfit Software API

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

**PLEASE NOTE**

Clubfit utilises OAuth2 for authentication and the `x-api-key` header for 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.

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.1

## Servers

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

## Security

### OAuth2

OAuth2 client credentials. Obtain a token from the /token endpoint.

Type: oauth2
Token URL: https://api.clubfit.net.au/v1/token
Scopes:
- `read`: Grants read access

### BasicAuth

Base64-encoded username:password supplied by Clubfit. Used only on /token.

Type: http
Scheme: basic

### ApiKeyAuth

API key per club, provided to you by Clubfit.

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

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

## Authentication

 - [POST /token](https://developer.clubfitsoftware.com.au/openapi/authentication/authenticationtoken.md): Retrieve an access token. Authenticate with HTTP Basic using the credentials supplied by Clubfit; the client sends `Authorization: Basic <base64(username:password)>`. The returned token is used as the
## Members

 - [GET /members](https://developer.clubfitsoftware.com.au/openapi/members/memberdata.md): Retrieve member details including contact and membership information.
 - [GET /members/attendance/classes](https://developer.clubfitsoftware.com.au/openapi/members/getmemberclassattendance.md): Get group class attendance from a particular date. Includes member and prospect class bookings, along with attendances recorded against a class for members who were not booked in. This does not includ
 - [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.
 - [GET /members/payment/history](https://developer.clubfitsoftware.com.au/openapi/members/getmemberpaymenthistory.md): Retrieve member payment history transaction information.
 - [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

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

 - [GET /financial/disbursements](https://developer.clubfitsoftware.com.au/openapi/financial/getfinancialdisbursements.md): Disbursement payments made to your club
 - [GET /financial/debtcollection](https://developer.clubfitsoftware.com.au/openapi/financial/getfinancialdebtcollection.md): Member details sent to debt collection