ProspectrDevelopers Open Prospectr
PROSPECTR DEVELOPERS

Put Prospectr on any website

Add a quote form to your site with one line of code, or connect your own forms and apps with the API. Every enquiry lands in Prospectr as a lead you can call.

Website forms

The quickest way to get enquiries from your website into Prospectr. There's no code to write.

  1. In Prospectr, open Forms and click New form.
  2. Pick your questions, button text and colour. Every form needs a Phone question.
  3. Click Get the code and paste it where the form should appear on your site.

It works on WordPress, Wix, Squarespace, Webflow, Shopify or any site that lets you add HTML. The form sizes itself to fit, and you can also share it as a plain link in texts, emails or on Facebook.

Make it match your site in the Design tab (colours, font, corners and answer boxes), or go further in Custom code: add your own CSS and HTML, or open the form's full code, copy it into ChatGPT or Claude with what you want changed, and paste the result back. Every change shows in the live preview as you type. Scripts are removed for security.

Step-by-step forms. Long form? Click Add a step in the Questions tab and the form splits into screens with Next and Back buttons and a progress bar. Each step checks its own answers before moving on. In full code, put data-pf-step="Step name" on each section. You can also add your own data-pf-progress, data-pf-next and data-pf-back elements, or Prospectr adds them for you.

Each form has its own page in Prospectr with its submissions, stats and a CSV export. You can pause a form, duplicate it, or send people to your own thank-you page after they submit.

Each submission becomes a lead in the list you choose. If you already have a lead with that phone number, the enquiry is added to its notes instead. Photos people upload are saved with the submission.

Paste on your website
<script src="{ORIGIN}/f/embed.js"
  data-prospectr-form="YOUR_FORM_CODE" async></script>
Or as a link
{ORIGIN}/f/YOUR_FORM_CODE
Custom CSS example
.pf-button { text-transform: uppercase; letter-spacing: .05em; }
.pf-title  { font-size: 28px; }
.pf-input  { border-width: 2px; }
/* Classes: .pf-card .pf-title .pf-intro .pf-field .pf-label
   .pf-input .pf-button .pf-success .pf-error
   Variables: --pf-color --pf-text --pf-radius --pf-font */
Steps in full code
<form id="pf">
  <div data-pf-step="About you"> ...questions... </div>
  <div data-pf-step="The job"> ...questions... </div>
  <button type="submit">Send</button>
</form>
<!-- Next, Back and the progress bar are added for you -->

API keys

Use the API when you want to send data from a form or app you built yourself. Create keys in Prospectr under Integrations → API & website forms. Each workspace has its own keys.

pk_Public key

Goes in your website. It's safe to show in page code.

  • Can send onboarding forms and new leads
  • Only from the websites you allow
  • Can't read anything
sk_Secret key

For your own server or a tool like Zapier. Never put it in a website.

  • Full access to send, read and update
  • Shown once when you create it
  • Create a new one to replace it
List your domains under Websites allowed to use it, e.g. yourbusiness.com.au. Requests from other sites get a 403. www. is included automatically.
Check a key works
curl {BASE}/ping \
  -H "Authorization: Bearer pk_…"
Response
{ "ok": true, "workspace": "Smith Plumbing", "key": "public" }

Making requests

Every request goes to this base URL and sends your key in the Authorization header. Requests and responses are JSON.

Australian phone numbers like 0412 345 678 are converted to +61412345678 for you.

Base URL
https://prospectr.site/v1
Headers
Authorization: Bearer YOUR_KEY
Content-Type: application/json
GET/ping
Key: publicsecret

Checks a key works and tells you which workspace and type of key it is.

Request
curl {BASE}/ping -H "Authorization: Bearer YOUR_KEY"
POST/onboarding
Key: publicsecret

A new client's onboarding form, with optional photos. Prospectr matches it to the lead with the same phone number or email, or creates a lead in a list called Clients. The deal is marked won and the form appears under Forms → Submissions.

phonerequiredstring
The client's phone number.
business, namestring
At least one is required.
email, trade, basedIn, domain, planstring
Optional. Filled into the lead when it doesn't have them yet.
answersarray
Any other questions as { label, value }. Up to 80.
filesarray
Photos or PDFs as { name, type, data }, where data is base64 or a data URL. Up to 20 files, 8 MB each, 18 MB in total.
sourcestring
Optional label for where it came from.
formstring
Optional form name, e.g. Website welcome. Prospectr makes a form with this name the first time it sees it, so these submissions get their own card, stats and list on the Forms page.
curl {BASE}/onboarding \
  -H "Authorization: Bearer pk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "business": "Smith Plumbing",
    "name": "Dave",
    "phone": "0412 345 678",
    "email": "dave@smithplumbing.com.au",
    "plan": "Growth",
    "answers": [
      { "label": "ABN", "value": "12 345 678 901" },
      { "label": "Suburbs covered", "value": "Gosford, Erina" }
    ]
  }'
201Response
{
  "ok": true,
  "id": "b7c1…",
  "leadId": "4f2a…",
  "matchedExistingLead": true,
  "files": 0
}
POST/leads
Key: publicsecret

A new lead, for example from a contact form you built yourself. If a lead with that phone number already exists, the message is added to its notes and the response has "duplicate": true.

phonerequiredstring
Their phone number.
name, business, email, website, address, categorystring
Optional details for the lead.
messagestring
Saved in the lead's notes.
liststring
Which list to add it to. Defaults to Inbound.
Request
curl {BASE}/leads \
  -H "Authorization: Bearer pk_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Jo", "phone": "0433 222 111",
        "message": "Need a quote", "list": "Website" }'
GET/leads
Key: secret

Your leads, newest first. GET /leads/:id returns one lead.

qquery
Search name, business, phone and email.
stagequery
interested, meeting, proposal, won or lost.
deliveryquery
paid, form_received, building, preview or live.
limitquery
Up to 500. Default 100.
Request
curl "{BASE}/leads?stage=won" \
  -H "Authorization: Bearer sk_…"
200Response
{
  "total": 1,
  "leads": [{
    "id": "4f2a…",
    "business": "Smith Plumbing",
    "phone": "+61412345678",
    "stage": "won",
    "delivery": "form_received",
    "plan": "Growth"
  }]
}
PATCH/leads/:id
Key: secret

Update a lead. Send only what changes.

deliverystring
paid, form_received, building, preview, live. Also marks the deal as won.
stagestring
A pipeline stage.
statusstring
A call outcome, e.g. callback or not_interested.
plan, valuestring, number
Plan name and deal value in dollars.
notestring
Added to the end of the lead's notes.
Request
curl -X PATCH {BASE}/leads/LEAD_ID \
  -H "Authorization: Bearer sk_…" \
  -H "Content-Type: application/json" \
  -d '{ "delivery": "preview", "note": "Preview sent" }'
GET/onboarding
Key: secret

Every onboarding form and website form submission, newest first, with all answers and a link for each file. GET /onboarding/:id returns one. To download a file, request its link with your secret key.

Request
curl {BASE}/onboarding -H "Authorization: Bearer sk_…"

Errors and limits

Errors come back as { "error": "…" } with a message you can show to people.

400Something is missing or wrong, like no valid phone number.
401The key is missing, wrong or turned off.
403The public key was used from a website that isn't allowed, or the route needs the secret key.
404That lead, form or route doesn't exist.
413The files are too big.
429Too many requests. Wait a little and try again.

Each workspace can take 60 onboarding forms, 300 API leads and 200 website form submissions an hour.

Try it

Send a real request to your workspace. Your key only stays in this browser tab.