Get a Lead by Email
Returns a lead’s details (First name, Last name, Email Address, Location, etc.) based on the “EmailId” you pass in the API URL.
If the “EmailId” doesn’t exist, the response will be empty (square brackets []).
Related APIs
- To retrieve a lead’s details using their lead Id, use the Get Lead by Id API.
- To retrieve a lead’s details using their phone number, use the Get Lead by Phone API.
API URL
URL
GET
https://{host}/v2/LeadManagement.svc/Leads.GetByEmailaddress?accessKey=AccessKey&secretKey=SecretKey&emailaddress=EmailAddress
URL Parameters
| Parameter | Description |
|---|---|
| EmailAddress | Email address of the lead. |
Response
200 OK
Content-Type: application/json
[
{
"ProspectID": "6f75b09d-0187-45d6-86dd-f848bd5a0aca",
"ProspectAutoId": "1016",
"FirstName": "George",
"LastName": "Jackson",
"EmailAddress": "george@example.com",
"Company": "Example Company",
"Origin": "Quick Add Form",
"Phone": null,
"Mobile": null,
"Website": null,
"TimeZone": null,
"Source": "Social Media",
"SourceMedium": null,
"Notes": null,
"SourceCampaign": null,
"SourceContent": null,
"DoNotEmail": "0",
"DoNotCall": "0",
"ProspectStage": "Tournament Participant",
"Score": "-10",
"Revenue": "25",
"EngagementScore": "0",
"TotalVisits": null,
"PageViewsPerVisit": null,
"AvgTimePerVisit": null,
"RelatedProspectId": null,
"ProspectActivityId_Min": "dafc8d1b-d5a1-11e7-9f0f-0236dfe9c25a",
"ProspectActivityDate_Min": "2017-11-30 07:40:18.000",
"Web_Referrer": null,
"Web_RefKeyword": null,
"ProspectActivityId_Max": "81fb23b3-a31b-4372-9c79-d06695028167",
"ProspectActivityName_Max": "Sales Activity",
"ProspectActivityDate_Max": "2017-12-04 07:30:00.000",
"RelatedLandingPageId": null,
"FirstLandingPageSubmissionId": null,
"FirstLandingPageSubmissionDate": null,
"OwnerId": "3b1041fb-8374-11e7-8758-0a106ee76b21",
"CreatedBy": "3b1041fb-8374-11e7-8758-0a106ee76b21",
"CreatedOn": "2017-11-30 07:38:00.000",
"ModifiedBy": "1a50c565-8525-11ea-a93b-0aa4c559f4ca",
"ModifiedOn": "2022-05-12 10:10:41.000",
"LeadConversionDate": null,
"StatusCode": "0",
"StatusReason": "0",
"IsLead": "1",
"mx_Street1": null,
"mx_Street2": null,
"mx_City": null,
"mx_State": null,
"mx_Country": "United States",
"mx_Zip": null,
"LastModifiedOn": "2022-05-12 10:10:41.000",
"mx_Weight_Division": "LightWeight",
"mx_Gym": null,
"mx_Athlete_Age": "20-25",
"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": null,
"mx_Is_Permanent_Address_Same_as_Current_Address": null,
"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-05-12 10:10:41.000",
"SourceReferrer": null,
"LastVisitDate": "2017-12-04 07:30:00.000",
"CompanyType": null,
"RelatedCompanyId": null,
"IsPrimaryContact": "0",
"MailingPreferences": null,
"QualityScore01": "5",
"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": null,
"RelatedCompanyOwnerId": null,
"CompanyTypeName": null,
"CompanyTypePluralName": null,
"LeadLastModifiedOn": "2022-05-12 10:10:41.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. |
