Skip to content

Clubfit Software API (BETA) (1.0)

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.


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

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://www.clubfitsoftware.com.au

E-mail

support@clubfitsoftware.com.au

Terms of Service

Languages
Servers

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

Authentication

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

Operations

Members

The member endpoints will return data relvant to member information.

Operations

Information

Request

Retrieve member details including contact and membership information.

Security
OAuth2
Query
fromdatestring(date-time)

Filter members by their membership start date.

Example: fromdate=2024-08-24T00:00:00
updatedatestring(date-time)

Filter members by their last update date.

Example: updatedate=2024-08-24T00:00:00
statusstring

Filter by current member status.

Enum"Active""PaymentIssue""Suspended""Archived""PendingActivation""PendingOnlineSignup"
offsetinteger(int32)

The index of the first result to return. Use with limit to get the next page of search results.

limitinteger(int32)[ 0 .. 500 ]

The maximum number of results to return.

Default 500
Headers
x-api-keystringrequired

Api key per club provided to you by Clubfit

curl -i -X GET \
  'https://api.clubfit.net.au/v1/members?fromdate=2024-08-24T00%3A00%3A00&updatedate=2024-08-24T00%3A00%3A00&status=Active&offset=0&limit=500' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: string'

Responses

search results matching criteria

Bodyapplication/json
hrefstring

Current API URL

Example: "https://api.clubfit.net.au/v1/members"
nextstring

Next API URL to retrieve the next page

Example: "https://api.clubfit.net.au/v1/members?limit=500&offset=500"
dataArray of objects(Member)
Response
application/json
{
  "href": "https://api.clubfit.net.au/v1/members",
  "next": "https://api.clubfit.net.au/v1/members?limit=500&offset=500",
  "data": [
    { … }
  ]
}

Visits

Request

Get member visits from a particular date. This does not include Creche, PT or Class visits.

Security
OAuth2
Query
fromdatestring(date-time)

Filter members by visit date and time.

Example: fromdate=2024-08-24T00:00:00
statusstring

Filter by current member status.

Enum"Active""PaymentIssue""Suspended""Archived""PendingActivation""PendingOnlineSignup"
offsetinteger(int32)

The index of the first result to return. Use with limit to get the next page of search results.

limitinteger(int32)[ 0 .. 500 ]

The maximum number of results to return.

Default 500
Headers
x-api-keystringrequired

Api key per club provided to you by Clubfit

curl -i -X GET \
  'https://api.clubfit.net.au/v1/members/attendance/visits?fromdate=2024-08-24T00%3A00%3A00&status=Active&offset=0&limit=500' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: string'

Responses

Member visits matching criteria

Bodyapplication/json
hrefstring

Current API URL

Example: "https://api.clubfit.net.au/v1/members/attendance/visits"
nextstring

Next API URL to retrieve the next page

Example: "https://api.clubfit.net.au/v1/member/attendance/visits?limit=500&offset=500"
dataArray of objects(MemberVisit)
Response
application/json
{
  "href": "https://api.clubfit.net.au/v1/members/attendance/visits",
  "next": "https://api.clubfit.net.au/v1/member/attendance/visits?limit=500&offset=500",
  "data": [
    { … }
  ]
}

Payment history

Request

Retrieve member payment history transaction information.

Security
OAuth2
Query
fromdatestring(date-time)

Filter payment history transactions by payment date and time.

Example: fromdate=2024-08-24T00:00:00
offsetinteger(int32)

The index of the first result to return. Use with limit to get the next page of search results.

limitinteger(int32)[ 0 .. 500 ]

The maximum number of results to return.

Default 500
Headers
x-api-keystringrequired

Api key per club provided to you by Clubfit

curl -i -X GET \
  'https://api.clubfit.net.au/v1/members/payment/history?fromdate=2024-08-24T00%3A00%3A00&offset=0&limit=500' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: string'

Responses

Member payment history transactions matching criteria

Bodyapplication/json
hrefstring

Current API URL

Example: "https://api.clubfit.net.au/v1/members/pos/transactions"
nextstring

Next API URL to retrieve the next page

Example: "https://api.clubfit.net.au/v1/member/pos/transactions?limit=500&offset=500"
dataArray of objects(MemberPaymentHistory)
Response
application/json
{
  "href": "https://api.clubfit.net.au/v1/members/pos/transactions",
  "next": "https://api.clubfit.net.au/v1/member/pos/transactions?limit=500&offset=500",
  "data": [
    { … }
  ]
}

POS transactions

Request

Retrieve member POS transactions information including staff member, line items and payments made.

Security
OAuth2
Query
fromdatestring(date-time)

Filter pos transactions by transaction date and time.

Example: fromdate=2024-08-24T00:00:00
offsetinteger(int32)

The index of the first result to return. Use with limit to get the next page of search results.

limitinteger(int32)[ 0 .. 500 ]

The maximum number of results to return.

Default 500
Headers
x-api-keystringrequired

Api key per club provided to you by Clubfit

curl -i -X GET \
  'https://api.clubfit.net.au/v1/members/pos/transactions?fromdate=2024-08-24T00%3A00%3A00&offset=0&limit=500' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: string'

Responses

Member POS transactions matching criteria

Bodyapplication/json
hrefstring

Current API URL

Example: "https://api.clubfit.net.au/v1/members/pos/transactions"
nextstring

Next API URL to retrieve the next page

Example: "https://api.clubfit.net.au/v1/member/pos/transactions?limit=500&offset=500"
dataArray of objects(MemberPOSTransaction)
Response
application/json
{
  "href": "https://api.clubfit.net.au/v1/members/pos/transactions",
  "next": "https://api.clubfit.net.au/v1/member/pos/transactions?limit=500&offset=500",
  "data": [
    { … }
  ]
}

Prospects

The prospect endpoints will return data relvant to prospect information.

Operations

Financial

The financial endpoints will return data relvant to financial information.

Operations