Quick Search Leads
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
This API performs the same function as the Quick Search feature of your LeadSquared web application. It returns the list of leads matching the key-value pair you pass in the API URL. You can search leads by specifying one of the following as the “Key” parameter in the URL –
- FirstName
- LastName
- EmailAddress
- Phone
- Mobile
- Company
- City
- Country
API URL
URL
GET
https://{host}/v2/LeadManagement.svc/Leads.GetByQuickSearch?accessKey=AccessKey&secretKey=SecretKey&key=Key
URL Parameters
| Parameter | Description |
|---|---|
| Key | Quick search parameter. For example, pass "Key=John" to retrieve all leads containing John in the Quick Search Enabled fields. |
Response
200 OK
Content-Type: application/json
[
{
"ProspectID":"08c04088-9d27-428c-8117-683425ae9a60",
"ProspectAutoId":"1138",
"FirstName":"John",
"LastName":"Danaher",
"EmailAddress":"johnd@example.com",
"Company":null,
"Origin":"F26",
"Phone":null,
"Mobile":null,
"Website":null,
"TimeZone":null,
"Source":null,
"SourceMedium":null,
"Notes":null,
"SourceCampaign":null,
"SourceContent":null,
"DoNotEmail":"1",
"DoNotCall":"0",
"ProspectStage":"Prospect",
"Score":"2",
"Revenue":null,
"EngagementScore":"0",
"TotalVisits":null,
"PageViewsPerVisit":null,
"AvgTimePerVisit":null,
"RelatedProspectId":null,
"ProspectActivityId_Min":"7739efff-0d10-11ea-aebf-02b00a4d022c",
"ProspectActivityDate_Min":"2019-11-22 10:09:36.000",
"Web_Referrer":null,
"Web_RefKeyword":null,
"ProspectActivityId_Max":"3618819c-f1f9-4d1e-9626-b553d5dd857c",
"ProspectActivityName_Max":"Document Collection",
"ProspectActivityDate_Max":"2022-03-25 13:31:15.000",
"RelatedLandingPageId":null,
"FirstLandingPageSubmissionId":null,
"FirstLandingPageSubmissionDate":null,
"OwnerId":"3b1041fb-8374-11e7-8758-0a106ee76b21",
"CreatedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
"CreatedOn":"2019-11-22 10:09:36.000",
"ModifiedBy":"1a50c565-8525-11ea-a93b-0aa4c559f4ca",
"ModifiedOn":"2022-06-09 08:37:23.000",
"LeadConversionDate":"2019-11-22 10:09:36.000",
"StatusCode":"0",
"StatusReason":"0",
"IsLead":"1",
"mx_Street1":null,
"mx_Street2":null,
"mx_City":null,
"mx_State":null,
"mx_Country":"United Kingdom",
"mx_Zip":null,
"LastModifiedOn":"2022-06-09 08:37:23.000",
"mx_Weight_Division":null,
"mx_Gym":null,
"mx_Athlete_Age":null,
"mx_Secondary_Email_Address":null,
"mx_Secondary_Email":null,
"mx_Custom_Score":null,
"mx_Age":null,
"mx_12th_Grade_Results":null,
"JobTitle":null,
"mx_Co_Applicant_First_Name":"Nicky",
"mx_Co_Applicant_Last_Name":"Danaher",
"mx_Co_Applicant_Email":null,
"mx_Permanent_Address_1":null,
"mx_Permanent_Address_2":null,
"mx_Do_You_Have_a_Co_Applicant":"Yes",
"mx_Is_Permanent_Address_Same_as_Current_Address":"Yes",
"mx_Renewal_Date":null,
"mx_Identification":null,
"mx_Identification_Documents":null,
"mx_Doctors":null,
"mx_Product":null,
"mx_WhatsApp_Opt_Out":null,
"mx_Date_of_Birth":null,
"mx_PAN_Number":null,
"mx_Fathers_Name":null,
"mx_Product_Price":null,
"mx_Product_Specification":null,
"mx_Products":null,
"mx_Docs":null,
"mx_Retype_Password":null,
"mx_Donation_Amount":null,
"mx_Course_Type":null,
"mx_Application_Submitted_On":null,
"mx_Video_KYC":null,
"mx_Company":null,
"mx_Aadhaar_Number":null,
"mx_Degree":null,
"mx_Documentation":null,
"NotableEvent":"Modified",
"NotableEventdate":"2022-06-09 08:37:23.000",
"SourceReferrer":"",
"LastVisitDate":"2022-03-25 13:31:15.000",
"CompanyType":null,
"RelatedCompanyId":null,
"IsPrimaryContact":"0",
"MailingPreferences":null,
"QualityScore01":null,
"TwitterId":null,
"FacebookId":null,
"LinkedInId":null,
"SkypeId":null,
"GTalkId":null,
"GooglePlusId":null,
"PhotoUrl":null,
"ConversionReferrerURL":null,
"SourceReferrerURL":null,
"SourceIPAddress":null,
"Latitude":null,
"Longitude":null,
"mx_Portal_IsPortalUser":null,
"CurrentOptInStatus":"Unknown",
"OptInDate":null,
"OptInDetails":null,
"LastOptInEmailSentDate":"2019-11-22 10:09:44.000",
"DoNotTrack":null,
"RelatedCompanyIdName":null,
"RelatedCompanyOwnerId":null,
"CompanyTypeName":null,
"CompanyTypePluralName":null,
"LeadLastModifiedOn":"2022-06-09 08:37:23.000",
"OwnerIdName":"Vir Singh",
"OwnerIdEmailAddress":"virkdsingh@gmail.com",
"Groups":"",
"CreatedByName":"Vir Singh",
"ModifiedByName":"Yogesh",
"Account_CompanyName":"Education 101",
"Account_ShortName":"t20170817174751",
"Account_TimeZone":"Asia/Kolkata",
"Account_Website":"lshelp.staging.wpengine.com",
"Account_Street1":"123 Street",
"Account_Street2":"",
"Account_City":"Bengaluru",
"Account_State":"Karnataka",
"Account_Country":"India",
"Account_Zip":"",
"Account_Fax":"",
"Account_Phone":"+91-8556010497",
"Owner_FirstName":"Vir",
"Owner_MiddleName":"",
"Owner_LastName":"Singh",
"Owner_EmailAddress":"virkdsingh@gmail.com",
"Owner_FullName":"Vir Singh",
"Owner_TimeZone":"Asia/Kolkata",
"Owner_AssociatedPhoneNumbers":"+91-999988888",
"Org_ShortCode":"22824",
"Account_Address":"Education 101{mxnewline}123 Street,{mxnewline},Bengaluru,Karnataka{mxnewline} {mxnewline}India.",
"IsStarredLead":"false",
"CanUpdate":"true"
}
]
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
