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 []).

Note:

  • If Object Types are enabled on your account, in the response, the LeadType is OT_0 by default. This means leads are the default Object Type. If you create custom object types, the LeadType is OT_1, OT_2, and so on.
  • If Object Types are not enabled in your account, you do not see any object type parameters in the response.

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
[
   {
      "LeadType":"OT_0",
      "FirstLandingPageSubmissionDate":null,
      "Web_RefKeyword":null,
      "Web_Referrer":null,
      "ProspectActivityDate_Min":"2025-11-14 03:10:00.000",
      "ProspectActivityDate_Max":"2025-11-25 07:47:26.000",
      "ProspectActivityName_Max":"Sales Activity",
      "LeadLastModifiedOn":"2025-11-25 07:47:41.000",
      "FirstLandingPageSubmissionId":null,
      "RelatedLandingPageId":null,
      "LastVisitDate":"2025-11-25 07:47:26.000",
      "NotableEventdate":"2025-11-25 07:47:41.000",
      "NotableEvent":"Modified",
      "SourceReferrer":null,
      "ProspectID":"bd595fc2-3678-4004-9ac6-65bfd1caadb5",
      "Longitude":null,
      "Latitude":null,
      "SourceIPAddress":null,
      "SourceReferrerURL":null,
      "ConversionReferrerURL":null,
      "StatusCode":"0",
      "ProspectActivityId_Min":"fb8bad57-2236-4f7c-be4c-04b4a3470592",
      "ProspectActivityId_Max":"c6d7226e-d096-4020-804a-82e524429f48",
      "StatusReason":"0",
      "RelatedProspectId":null,
      "ProspectAutoId":"1024",
      "DeletionStatusCode":"0",
      "IsLead":"1",
      "FirstName":"Nivas",
      "LastName":"Ravi",
      "EmailAddress":"nivas@leadsquard.com",
      "Phone":"+91-9988776655",
      "Company":null,
      "Website":null,
      "DoNotSMS":"0",
      "DoNotTrack":"0",
      "DoNotEmail":"0",
      "DoNotCall":"0",
      "Source":null,
      "SourceCampaign":null,
      "Mobile":null,
      "SourceMedium":null,
      "SourceContent":null,
      "JobTitle":null,
      "Notes":null,
      "Revenue":"0",
      "EngagementScore":"0",
      "Score":"6",
      "QualityScore01":null,
      "ProspectStage":"Customer",
      "OwnerId":"7511e6c2-9df5-11f0-91df-068012126923",
      "CreatedByName":"Nivas Ravi",
      "CreatedBy":"7511e6c2-9df5-11f0-91df-068012126923",
      "LeadConversionDate":"2025-11-04 09:07:42.000",
      "CreatedOn":"2025-11-04 09:07:42.000",
      "ModifiedByName":"Nivas Ravi",
      "ModifiedBy":"7511e6c2-9df5-11f0-91df-068012126923",
      "ModifiedOn":"2025-11-25 07:47:41.000",
      "TimeZone":null,
      "TotalVisits":null,
      "PageViewsPerVisit":null,
      "AvgTimePerVisit":null,
      "mx_Street1":null,
      "mx_Street2":null,
      "mx_City":null,
      "mx_State":null,
      "mx_Country":null,
      "mx_Zip":null,
      "OwnerIdName":"Nivas Ravi",
      "OwnerIdEmailAddress":"nivas.78101@lsqdev.in",
      "Origin":"Lead Add Form",
      "MailingPreferences":null,
      "Groups":null,
      "PhotoUrl":null,
      "TwitterId":null,
      "FacebookId":null,
      "LinkedInId":null,
      "SkypeId":null,
      "GooglePlusId":null,
      "GTalkId":null,
      "CurrentOptInStatus":"Unknown",
      "OptInDate":null,
      "OptInDetails":null,
      "LastOptInEmailSentDate":null,
      "LeadAge":"99",
      "mx_Residential_Address":"{}",
      "LeadTypeAssociation_OT_1_OT_2":null,
      "LeadTypeAssociation_OT_2_OT_1":null,
      "LeadTypeAssociation_OT_3_OT_4":null,
      "LeadTypeAssociation_OT_4_OT_3":null,
      "LeadTypeAssociation_OT_4_OT_2":null,
      "mx_Portal_IsPortalUser":null,
      "LeadTypeAssociation_OT_3_OT_1":null,
      "LeadTypeAssociation_OT_4_OT_1":null,
      "LeadTypeAssociation_OT_1_OT_3":null,
      "mx_Loan_Number":null,
      "LeadTypeAssociation_OT_4_OT_4":null,
      "LeadTypeAssociation_OT_5_OT_4":null,
      "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.