Skip to main content
GET
/
general-leads
List general leads
curl --request GET \
  --url https://www.renovationfind.com/rest-manager-api-v1/general-leads \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://www.renovationfind.com/rest-manager-api-v1/general-leads"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.renovationfind.com/rest-manager-api-v1/general-leads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://www.renovationfind.com/rest-manager-api-v1/general-leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://www.renovationfind.com/rest-manager-api-v1/general-leads"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://www.renovationfind.com/rest-manager-api-v1/general-leads")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://www.renovationfind.com/rest-manager-api-v1/general-leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "content": [
      {
        "id": 123,
        "customerName": "<string>",
        "dateCreated": "2023-11-07T05:31:56Z",
        "dateModified": "2023-11-07T05:31:56Z",
        "renofindLeadType": "<string>",
        "generalLeadStatus": "<string>",
        "specificLeadStatus": "<string>",
        "paymentStatus": "<string>",
        "leadSourceType": "<string>",
        "phoneLead": true,
        "referrerVendorId": 123,
        "referrerName": "<string>",
        "endCustomer": {
          "id": 123,
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>"
        },
        "jobAmount": 123,
        "requiresAction": true,
        "requireActionReason": "<string>"
      }
    ],
    "totalElements": 123,
    "totalPages": 123,
    "size": 123,
    "number": 123
  }
}

Authorizations

Authorization
string
header
required

JWT token issued from the RenovationFind Manager Portal

Query Parameters

view
enum<string>
default:ALL
Available options:
ALL,
PQ,
PAP,
ACTION_REQUIRED
filter
enum<string>
Available options:
ALL,
NEW,
ATTEMPTED_CONTACT,
LONG_TERM_FOLLOW_UP,
READY_TO_SEND,
PQR_LEAD_SENT,
PAP_LEAD_SENT,
FOLLOW_UP_CALL,
CLOSED_DEAL,
JOB_FINISHED,
FAILED,
NEW_UNPROCESSED,
ACKNOWLEDGED,
FULLY_PROCESSED,
PQR_LEAD,
PAP_LEAD
searchQuery
string
default:""
Maximum string length: 200
page
integer
default:0
size
integer
default:10
Required range: x <= 50

Response

200 - application/json

Paginated general leads

success
boolean
data
object