Overview
Gets leads created with the provided API key.
Endpoint URL
GET https://api.ritabyaire.com/leads
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
page | number | No | The page number to request. |
pageSize | number | No | The number of records per page. Max is 50. |
sortOrder | string | No | Enum: "asc", "desc". The direction to sort results in. Defaults to asc. |
lastModifiedAfter | string <date-time> | No | Filter to records modified after provided date. |
lastModifiedBefore | string <date-time> | No | Filter to records modified before provided date. |
Expected Response
200 OK - Successfully retrieved leads.
{
"data": {
"totalRecords": 0,
"totalPages": 0,
"currentPage": 0,
"results": [
{
"status": "Pending",
"type": "Buyer Enquiry",
"dateEnquired": "2019-08-24T14:15:22Z",
"contact": {
"firstName": "string",
"lastName": "string",
"email": { "value": "string" },
"mobile": { "value": "string" }
},
"property": {
"address": "string",
"suburb": "string"
}
}
]
}
}