Skip to content

Prospects

The prospect endpoints will return data relevant to prospect information.

Operations

Information

Request

Retrieve prospect details including contact and trial information.

Security
OAuth2 and ApiKeyAuth
Query
fromdatestring^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?$

Filter prospects by their last status update date and time.

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

Filter by current prospect status.

Enum:"Trial_Expired""Enquiry""NotInterested""OnTrial""Tour""NoSaleReturn""DidNotShow""Sale"
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
GET
/prospects
curl -i -X GET \
  'https://api.clubfit.net.au/v1/prospects?fromdate=2024-08-24T00%3A00%3A00&status=Trial_Expired&offset=0&limit=500' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

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
{
  "href": "https://api.clubfit.net.au/v1/prospects",
  "next": "https://api.clubfit.net.au/v1/prospects?limit=500&offset=500",
  "data": [
    { … }
  ]
}