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_idis 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"
import requests
import json
url = "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"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("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", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("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", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('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')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"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
}
}
{
"message": "Invalid or expired access token."
}
{
"message": "Access token does not permit this action."
}
{
"message": "Too many requests."
}
/prospects
Target server for requests. Edit to use your own host.
An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
imp_at_. Send it as Authorization: Bearer imp_at_XXXX.Match a name, email or phone.
A stage name from the options endpoint.
Match a source.
Match a consultant.
HCP, NDIS, CHSP or Private.
Only converted, or only unconverted, prospects.
Lead date from, YYYY-MM-DD.
Lead date to, YYYY-MM-DD.
Follow-ups due on or before this date, YYYY-MM-DD.
Page number, 1 or greater.
1 to 100. Defaults to 20.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Query Parameters
Match a name, email or phone.
A stage name from the options endpoint.
Match a source.
Match a consultant.
HCP, NDIS, CHSP or Private.
Only converted, or only unconverted, prospects.
Lead date from, YYYY-MM-DD.
Lead date to, YYYY-MM-DD.
Follow-ups due on or before this date, YYYY-MM-DD.
Page number, 1 or greater.
1 to 100. Defaults to 20.
Responses
OK