GET - Retrieve List of Leads
Retrieve multiple leads at the same time based on the page and page size
Retrieve Multiple Leads:
Method: GET
Endpoint: /lead?page=<page_number>&pageSize=<pagesize>
Headers:
Name
Value
Content-Type
application/json
Authorization
Bearer <API TOKEN>
Example Request (JavaScript - Fetch):
const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <API TOKEN>");
const requestOptions = {
method: "GET",
headers: myHeaders,
redirect: "follow"
};
fetch("https://bizmate.fasttask.net/api/v1/lead?page=1&pageSize=100", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
Example Request (cURL):
curl --location 'https://bizmate.fasttask.net/api/v1/lead?page=1&pageSize=100' \
--header 'Authorization: Bearer <API TOKEN>'Response
[
{
"id": "",
"createdAt": "2024-08-02T05:43:45.884Z",
"createdBy": "ef62415c-ba77-41c2-9328-36ed7eced734",
"updatedAt": "2024-08-08T00:20:23.435Z",
"updatedBy": "e3ca507e-3f06-47b8-80d9-62e7f98a1a4e",
"fields": {
"status": "Converted",
"watchers": [],
"statusSinceDate": "2024-08-08T00:20:16.000Z",
"subStatusSinceDate": "2024-08-08T00:20:16.000Z",
"delegateTo": {
"type": "user",
"id": ""
},
"lastActivityDate": null,
"subStatus": "Banks In",
"firstName": "Some Text",
"lastName": "Some Text",
"companyName": "Some Text",
"broker": {
"id": "",
"name": "Test Bizcap"
},
"brokerRep": {
"id": "",
"firstName": "Test Bizcap",
"lastName": "Partner Contact"
},
"residentialAddress": {
"addressLine1": "string",
"addressLine2": "string",
"country": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"fullAddress": "string, string, string, string, string, string"
},
"businessAddress": {
"addressLine1": "string",
"addressLine2": "string",
"country": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"fullAddress": "string, string, string, string, string, string"
},
"physicalAddress": {
"addressLine1": "string",
"addressLine2": "string",
"country": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"fullAddress": "string, string, string, string, string, string"
},
"tradingAddress": {
"addressLine1": "string",
"addressLine2": "string",
"country": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"fullAddress": "string, string, string, string, string, string"
},
"nzbn": null,
"phone": "+1111111111",
"email": "some@email.com",
"bankStatementsUpdateLink": "",
"bankStatementsCreditsSenseLink": "",
"provisoLinkPdf": "",
"bankStatementsReceived": "No",
"industryCategory": "Some Text",
"industry": "Some Text",
"dateOfBirth": "2024-01-01",
"driversLicenseNumber": "Some Text",
"citizenshipStatus": "Permanent Resident",
"soleDirector": "Yes",
"loanPurpose": "Equipment Purchase",
"averageMonthlyTurnover": "123.00",
"callClientOrBroker": "Call Client",
"applicationLink": "",
"documentId": "Some Text",
"tradingName": "Some Text",
"applicationCompleted": null,
"applicationCompletedDate": null,
"bankStatementsReceivedDate": null,
"businessStartDate": "2024-01-01",
"amountRequested": "123.00",
"internalBdmUser": null,
"secondaryPhone": "+1111111111",
"loanType": null,
"homeOwner": "Yes",
"secondaryEmail": "some@email.com",
"suitableProducts": [
"LOC"
],
"driverVersionNumber": "Some Text",
"leadSource": "API",
"numberOfCallsMade": 0,
"lastCallDate": null,
"callOnBehalfOf": "Some Text",
"partnerLeadReferenceId": "Some Text",
"convertedDealId": ""
}
},
{
"id": "",
"createdAt": "2024-08-02T05:43:45.884Z",
"createdBy": "ef62415c-ba77-41c2-9328-36ed7eced734",
"updatedAt": "2024-08-08T00:20:23.435Z",
"updatedBy": "e3ca507e-3f06-47b8-80d9-62e7f98a1a4e",
"fields": {
"status": "Converted",
"watchers": [],
"statusSinceDate": "2024-08-08T00:20:16.000Z",
"subStatusSinceDate": "2024-08-08T00:20:16.000Z",
"delegateTo": {
"type": "user",
"id": ""
},
"lastActivityDate": null,
"subStatus": "Banks In",
"firstName": "Some Text",
"lastName": "Some Text",
"companyName": "Some Text",
"broker": {
"id": "",
"name": "Test Bizcap"
},
"brokerRep": {
"id": "",
"firstName": "Test Bizcap",
"lastName": "Partner Contact"
},
"residentialAddress": {
"addressLine1": "string",
"addressLine2": "string",
"country": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"fullAddress": "string, string, string, string, string, string"
},
"businessAddress": {
"addressLine1": "string",
"addressLine2": "string",
"country": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"fullAddress": "string, string, string, string, string, string"
},
"physicalAddress": {
"addressLine1": "string",
"addressLine2": "string",
"country": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"fullAddress": "string, string, string, string, string, string"
},
"tradingAddress": {
"addressLine1": "string",
"addressLine2": "string",
"country": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"fullAddress": "string, string, string, string, string, string"
},
"nzbn": null,
"phone": "+1111111111",
"email": "some@email.com",
"bankStatementsUpdateLink": "",
"bankStatementsCreditsSenseLink": "",
"provisoLinkPdf": "",
"bankStatementsReceived": "No",
"industryCategory": "Some Text",
"industry": "Some Text",
"dateOfBirth": "2024-01-01",
"driversLicenseNumber": "Some Text",
"citizenshipStatus": "Permanent Resident",
"soleDirector": "Yes",
"loanPurpose": "Equipment Purchase",
"averageMonthlyTurnover": "123.00",
"callClientOrBroker": "Call Client",
"applicationLink": "",
"documentId": "Some Text",
"tradingName": "Some Text",
"applicationCompleted": null,
"applicationCompletedDate": null,
"bankStatementsReceivedDate": null,
"businessStartDate": "2024-01-01",
"amountRequested": "123.00",
"internalBdmUser": null,
"secondaryPhone": "+1111111111",
"loanType": null,
"homeOwner": "Yes",
"secondaryEmail": "some@email.com",
"suitableProducts": [
"LOC"
],
"driverVersionNumber": "Some Text",
"leadSource": "API",
"numberOfCallsMade": 0,
"lastCallDate": null,
"callOnBehalfOf": "Some Text",
"partnerLeadReferenceId": "Some Text",
"convertedDealId": ""
}
}
]{
"error": "Invalid request"
}Last updated
