Get Leads
Base URL
GET/v1/leads/bulks
Query Parameters
id: long
leadId: long
fromDate: string (Eg: 2025-08-24T21:00:00.000Z)
toDate: string (Eg: 2025-08-24T21:00:00.000Z)
source: integer (optional)
subSource: integer (optional)
Note
Either id or leadId and fromDate and toDate is mandatory.
Also, date range should be 7 days
In case leadId given with date range, respective lead info alone will retrieve
Response
{
"leads": [
{
"leadExternalId": 574,
"leadId": 0,
"isError": 0,
"errorList": null,
"leadType": "Individual",
"title": "Mr",
"gender": "Male",
"nationality": "saudi",
"firstName": "first name",
"middleName": "middle name",
"lastName": "last name",
"contactName": "string",
"companyName": "string",
"companyIndustryType": "string",
"dateOfBirth": "2022-08-12",
"occupation": "occupation",
"customerCountry": "Saudi Arabia",
"customerRegion": "Riyadh",
"customerCity": "Afif",
"address1": "address1",
"address2": "address2",
"phoneCode": "00966",
"phoneNumber": "500000005",
"email": "john@example.com",
"monthlyIncome": "5000-10000 SAR",
"preferredLanguage": "Arabic",
"preferredContactType": "Email",
"company": "JTC",
"brand": "KIA",
"businessArea": "Sales",
"branch": null,
"leadDate": "2025-08-12",
"interest": "Price Quote",
"source": "Direct Contact",
"subSource": "Email",
"leadName": "leadname",
"leadReference": "lead reference",
"leadNote": "leadnote",
"vehicleType": "New",
"vehicles": [
{
"leadVehiclesId": 575,
"modelFamily": "RIO",
"modelYear": 2024,
"modelMemo": "Model Memo",
"modelPreferences": "Model Preferences",
"totalQty": 1
}
],
"purchasePlan": "Within 30 Days",
"paymentMode": "Credit",
"currency": "SAR",
"priority": "Warm",
"testDriveRequired": true,
"acceptNewsLetter": true,
"acceptMarketing": true,
"acceptPrivatePolicy": true
}
],
"createdDate": "2025-08-24T21:00:00.000Z",
"createdBy": 1,
"totalRecords": 1,
"errorRecords": 0,
"isProcessed": 2
}
Notes
errorRecords states the error count
isProcessed states the enum of
1 - means created
2 - means inprogress
3 - means cancelled
4 - means completed
leads states list of leads which are sent against this Id
`leadId` created in DMS
`errorList` explains the errors that is occurring against the `leadId`