LeadSquared Developer Centre

ON THIS PAGE

Quick Search Leads


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
Icon
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 "FirstName=John" to retrieve all leads with the first name John.

Response

200 OK
Content-Type: application/json
							
								

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.

On this page

© 2022 by MarketXpander Services Pvt Ltd. All Rights Reserved.