ProspectsList prospects

List prospects

Needs: Prospects, Read

Searches and lists prospects by name, email or phone, with pipeline stage, consultant, source, funding, dates and conversion status. These are the same records as the Prospects page, newest first.

Note: client_id is set once the prospect has been converted to a client.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/prospects?query=example_string&stage=example_string&source=example_string&consultant=example_string&funding_type=example_string&converted=true&from=example_string&to=example_string&followup_before=example_string&page=25&per_page=25" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": [
    {
      "id": 21,
      "name": "Example Prospect",
      "first_name": "Example",
      "last_name": "Prospect",
      "email": "example.prospect@example.com",
      "phone": "0400 000 000",
      "suburb": "Perth",
      "date_of_lead": "2026-02-20",
      "stage": "New",
      "tags": [],
      "source": "Website",
      "consultant": "Example Consultant",
      "funding_type": "NDIS",
      "followup_date": "2026-03-05",
      "converted": false,
      "client_id": null
    }
  ],
  "meta": {
    "page": 1,
    "total": 1,
    "last_page": 1
  }
}
GET
/prospects
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
query
querystring

Match a name, email or phone.

query
stagestring

A stage name from the options endpoint.

query
sourcestring

Match a source.

query
consultantstring

Match a consultant.

query
funding_typestring

HCP, NDIS, CHSP or Private.

query
convertedboolean

Only converted, or only unconverted, prospects.

query
fromstring

Lead date from, YYYY-MM-DD.

query
tostring

Lead date to, YYYY-MM-DD.

query
followup_beforestring

Follow-ups due on or before this date, YYYY-MM-DD.

query
pageinteger

Page number, 1 or greater.

query
per_pageinteger

1 to 100. Defaults to 20.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Query Parameters

querystring

Match a name, email or phone.

stagestring

A stage name from the options endpoint.

sourcestring

Match a source.

consultantstring

Match a consultant.

funding_typestring

HCP, NDIS, CHSP or Private.

convertedboolean

Only converted, or only unconverted, prospects.

fromstring

Lead date from, YYYY-MM-DD.

tostring

Lead date to, YYYY-MM-DD.

followup_beforestring

Follow-ups due on or before this date, YYYY-MM-DD.

pageinteger

Page number, 1 or greater.

per_pageinteger

1 to 100. Defaults to 20.

Responses

OK