Skip to main content
GET
/
general-leads
List vendor-assigned leads
curl --request GET \
  --url https://www.renovationfind.com/rest-api-v1/general-leads \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "content": [
      {
        "id": 123,
        "dateCreated": "2023-11-07T05:31:56Z",
        "dateModified": "2023-11-07T05:31:56Z",
        "actionDate": "2023-11-07T05:31:56Z",
        "category": "<string>",
        "customerName": "<string>",
        "customerEmail": "jsmith@example.com",
        "customerPhone": "<string>",
        "customerAddress": "<string>",
        "projectDetailsHtml": "<string>",
        "originalJobDescription": "<string>",
        "vendorNotificationViewed": true,
        "vendorLeadAction": "NONE",
        "declineReason": "<string>",
        "postLeadStatus": "NO_RESPONSE",
        "postLeadRequiresAction": true
      }
    ],
    "page": 123,
    "size": 123,
    "totalElements": 123,
    "totalPages": 123,
    "last": true
  }
}

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,
ACCEPTED,
REQUIRES_ATTENTION

Response

Paginated list of vendor-assigned leads

​
success
boolean
Example:

true

​
data
object