# Information

Retrieve prospect details including contact and trial information.

Endpoint: GET /prospects
Version: 1.0
Security: OAuth2

## Query parameters:

  - `fromdate` (string)
    Filter prospects by their last status update date and time.
    Example: "2024-08-24T00:00:00"

  - `status` (string)
    Filter by current prospect status.
    Enum: "Trial_Expired", "Enquiry", "NotInterested", "OnTrial", "Tour", "NoSaleReturn", "DidNotShow", "Sale"

  - `offset` (integer)
    The index of the first result to return. Use with limit to get the next page of search results.

  - `limit` (integer)
    The maximum number of results to return.

## Header parameters:

  - `x-api-key` (string, required)
    Api key per club provided to you by Clubfit

## Response 200 fields (application/json):

  - `href` (string)
    Current API URL
    Example: "https://api.clubfit.net.au/v1/prospects"

  - `next` (string)
    Next API URL to retrieve the next page
    Example: "https://api.clubfit.net.au/v1/prospects?limit=500&offset=500"

  - `data` (array)

  - `data.Number` (string)
    Example: "1000"

  - `data.FirstName` (string)
    Example: "John"

  - `data.LastName` (string)
    Example: "Doe"

  - `data.Status` (string)
    Example: "Active"

  - `data.Barcode` (string)
    Example: "51234"

  - `data.DateOfBirth` (string)
    Example: "2000-01-01T00:00:00"

  - `data.Gender` (string)
    Example: "M"

  - `data.TrialStartDate` (string)
    Example: "2000-01-01T00:00:00"

  - `data.TrialEndDate` (string)
    Example: "2000-01-01T00:00:00"

  - `data.CreatedDateUtc` (string)
    Example: "2000-01-01T00:00:00"

  - `data.ContactMethod` (object)

  - `data.ContactMethod.Id` (integer)
    Example: 123

  - `data.ContactMethod.Name` (string)
    Example: "abc"

  - `data.Source` (object)

  - `data.SourcePage` (string)
    Example: "abc"

  - `data.SalesPerson` (object)

  - `data.SalesPerson.Email` (string)
    Example: "john@doe.com"

  - `data.Contact` (object)

  - `data.Contact.OptOutEmail` (boolean)
    true the contact has opted out to email communication

  - `data.Contact.Mobile` (string)
    Example: "0424000000"

  - `data.Contact.OptOutSms` (boolean)
    true the contact has opted out to sms communication

  - `data.Contact.Home` (string)
    Example: "0712345661"

  - `data.Contact.Work` (string)
    Example: "074555667"

  - `data.Contact.Address` (string)
    Example: "1 No way Street"

  - `data.Contact.Suburb` (string)
    Example: "Sunnyhills"

  - `data.Contact.State` (string)
    Example: "QLD"

  - `data.Contact.Postcode` (string)
    Example: "1024"