Prospects

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

Prospects

The prospect endpoints will return data relvant to prospect information.

Operations

Information

Request

Retrieve prospect details including contact and trial information.

Query
fromdatestring(date-time)

Filter prospects by their last status update 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/prospects?fromdate=2024-08-24T00%3A00%3A00&limit=500&offset=0&status=Active' \
  -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/prospects"
nextstring

Next API URL to retrieve the next page

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

Financial

The financial endpoints will return data relvant to financial information.

Operations