LeadSquared Developer Centre

ON THIS PAGE

Get a Lead by Id

This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Run in Postman

Returns the details of a single lead (First name, Last name, Email Address, Location, etc.) based on the “LeadId” you pass in the API URL.
If the “LeadId” doesn’t exist, the response will be empty (square brackets []).

Related APIs

  • To retrieve a lead’s details using their email Id, use the Get Lead by Email API.
  • To retrieve a lead’s details using their phone number, use the Get Lead by Phone API.

API URL

URL
Icon
GET https://{host}/v2/LeadManagement.svc/Leads.GetById?accessKey=AccessKey&secretKey=SecretKey&id=id

URL Parameters

Parameter Description
id Unique identified of the lead.

Response

200 OK
Content-Type: application/json
[
   {
      "OptedOutDate":null,
      "ProspectActivityName_Min":null,
      "ProspectID":"df01c77d-a0da-4ed2-b59f-94febf1a1a21",
      "ProspectAutoId":"1038",
      "FirstName":"John",
      "LastName":"Travolta",
      "EmailAddress":null,
      "Company":"Example Company",
      "Origin":"Quick Add Form",
      "Phone":null,
      "Mobile":null,
      "Website":null,
      "TimeZone":null,
      "Source":"Organic Search",
      "SourceMedium":null,
      "Notes":null,
      "SourceCampaign":null,
      "SourceContent":null,
      "DoNotEmail":"0",
      "DoNotCall":"0",
      "ProspectStage":"Prospect",
      "Score":"10",
      "Revenue":null,
      "EngagementScore":"0",
      "TotalVisits":null,
      "PageViewsPerVisit":null,
      "AvgTimePerVisit":null,
      "RelatedProspectId":null,
      "ProspectActivityId_Min":"d45d3654-c3c9-4ea4-9f11-1556b16bfff3",
      "ProspectActivityDate_Min":"2022-03-25 13:34:40.000",
      "Web_Referrer":null,
      "Web_RefKeyword":null,
      "ProspectActivityId_Max":"d45d3654-c3c9-4ea4-9f11-1556b16bfff3",
      "ProspectActivityName_Max":"Document Collection",
      "ProspectActivityDate_Max":"2022-03-25 13:34:40.000",
      "RelatedLandingPageId":null,
      "FirstLandingPageSubmissionId":null,
      "FirstLandingPageSubmissionDate":null,
      "OwnerId":"3b1041fb-8374-11e7-8758-0a106ee76b21",
      "CreatedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
      "CreatedOn":"2018-03-06 06:55:20.000",
      "ModifiedBy":"3b1041fb-8374-11e7-8758-0a106ee76b21",
      "ModifiedOn":"2022-06-24 09:23:53.000",
      "LeadConversionDate":null,
      "StatusCode":"0",
      "StatusReason":"0",
      "IsLead":"1",
      "mx_Street1":null,
      "mx_Street2":null,
      "mx_City":null,
      "mx_State":null,
      "mx_Country":"Afghanistan",
      "mx_Zip":null,
      "LastModifiedOn":"2022-06-24 09:23:53.000",
      "mx_Weight_Division":"MiddleWeight",
      "mx_Gym":null,
      "mx_Athlete_Age":"25-30",
      "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":null,
      "mx_Co_Applicant_Last_Name":null,
      "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":null,
      "mx_Renewal_Date":null,
      "mx_Identification":null,
      "mx_Identification_Documents":"{\"Status\":\"Pending\",\"mx_CustomObject_1\":\"\",\"mx_CustomObject_2\":\"\",\"mx_CustomObject_3\":\"\",\"mx_CustomObject_4\":\"\"}",
      "mx_Doctors":null,
      "mx_Product":null,
      "mx_WhatsApp_Opt_Out":"0",
      "mx_Date_of_Birth":null,
      "mx_PAN_Number":null,
      "mx_Fathers_Name":null,
      "mx_Product_Price":null,
      "mx_Product_Specification":null,
      "mx_Products":"{\"Status\":\"Pending\",\"mx_CustomObject_1\":\"\"}",
      "mx_Docs":"{\"Status\":\"Pending\",\"mx_CustomObject_1\":\"\",\"mx_CustomObject_2\":\"\",\"mx_CustomObject_3\":\"\",\"mx_CustomObject_4\":\"\"}",
      "mx_Retype_Password":null,
      "mx_Donation_Amount":null,
      "mx_Course_Type":null,
      "mx_Application_Submitted_On":null,
      "mx_Video_KYC":"{\"Status\":\"Pending\",\"mx_CustomObject_1\":\"\"}",
      "mx_Company":null,
      "mx_Aadhaar_Number":null,
      "mx_Degree":"MA Anthropology",
      "mx_Documentation":null,
      "NotableEvent":"Modified",
      "NotableEventdate":"2022-06-24 09:23:53.000",
      "SourceReferrer":null,
      "LastVisitDate":"2022-03-25 13:34:40.000",
      "CompanyType":"5003",
      "RelatedCompanyId":"71bb9661-67ef-4afa-8fb8-d6763a109d61",
      "IsPrimaryContact":"0",
      "MailingPreferences":null,
      "QualityScore01":"3.33",
      "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":null,
      "DoNotTrack":null,
      "RelatedCompanyIdName":"College B",
      "RelatedCompanyOwnerId":"9a86dca1-9d0b-11e7-b0ab-02e89b2fb8f4",
      "CompanyTypeName":"College",
      "CompanyTypePluralName":"Colleges",
      "LeadLastModifiedOn":"2022-06-24 09:23:53.000",
      "OwnerIdName":"Vir Singh",
      "OwnerIdEmailAddress":"virkdsingh@gmail.com",
      "Groups":"",
      "CreatedByName":"Vir Singh",
      "ModifiedByName":"Vir Singh",
      "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.",
      "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.

On this page

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