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

url = "https://www.renovationfind.com/rest-api-v1/referral-requests"

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-api-v1/referral-requests', 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-api-v1/referral-requests",
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-api-v1/referral-requests"

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-api-v1/referral-requests")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://www.renovationfind.com/rest-api-v1/referral-requests")

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,
  "message": "<string>"
}
{
"success": false,
"error": "<string>"
}
{
"success": false,
"error": "Rate limit exceeded. Maximum 250 requests per 5 minutes. Please retry later."
}

Authorizations

Authorization
string
header
required

JWT token issued from the RenovationFind Manager Portal

Query Parameters

page
integer
default:0
Required range: x >= 0
size
integer
default:10

Page size (max 100)

Required range: 1 <= x <= 100
filter
enum<string>
default:ALL
Available options:
ALL,
AD_HOC,
VIA_REPUTATION_PROCESS
referralRequestFilter
enum<string>
default:ALL
Available options:
ALL,
SEND_PENDING,
SEND_COMPLETED,
SEND_FAILED

Response

Paginated list of referral requests

success
boolean
Example:

true

message
string