Get a Lead by Email - Api Docs

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

GET

https://{host}/v2/LeadManagement.svc/Leads.GetByEmailaddress?accessKey=AccessKey&secretKey=SecretKey&emailaddress=EmailAddress

Copy URL

URL Parameters

Parameter	Description
EmailAddress	Email address of the lead.

Response

200 OK

Content-Type: application/json

[
    {
        "ProspectID": " Lead Id ",
        "FirstName": "Syed Rizwan Ali",
        "LastName": null,
        "EmailAddress": "rizwan@yopmail.com",
        "Company": null,
        "Origin": "Contact Form 7 Id 3940",
        "Phone": null,
        "Mobile": null,
        "Fax": null,
        "Website": null,
        "TimeZone": null,
        "Region": null,
        "JobTitle": null,
        "Source": "Contact Form 7",
        "SourceMedium": "FD.com:Price",
        "Notes": null,
        "SourceCampaign": null,
        "SourceContent": null,
        "DoNotEmail": "0",
        "DoNotCall": "0",
        "ProspectStage": "Opportunity",
        "Grade": null,
        "Score": "0",
        "Revenue": null,
        "EngagementScore": "0",
        "TotalVisits": null,
        "PageViewsPerVisit": null,
        "AvgTimePerVisit": null,
        "RelatedProspectId": null,
        "ProspectActivityId_Min": null,
        "ProspectActivityDate_Min": null,
        "Web_Referrer": null,
        "Web_RefKeyword": null,
        "ProspectActivityId_Max": null,
        "ProspectActivityName_Max": null,
        "ProspectActivityDate_Max": null,
        "RelatedLandingPageId": null,
        "FirstLandingPageSubmissionId": null,
        "FirstLandingPageSubmissionDate": null,
        "OwnerId": "OwnerId",
        "CreatedBy": "Owner who create lead",
        "CreatedOn": "2015-07-31 06:35:37.000",
        "ModifiedBy": "User who modified ",
        "ModifiedOn": "2015-09-11 05:55:23.000",
        "LeadConversionDate": null,
        "StatusCode": "0",
        "StatusReason": "0",
        "IsLead": "1",
        "mx_Street1": null,
        "mx_Street2": null,
        "mx_City": null,
        "mx_State": null,
        "mx_Country": null,
        "mx_Zip": null,
        "mx_Geography": null,
        "mx_DOB": null,
        "mx_Anniversary": null,
        "mx_FaceBookURL": null,
        "mx_TwitterURL": null,
        "mx_LinkedInURL": null,
        "JobTitleLevel": null,
        "mx_Your_Intrest": null,
        "mx_Lead_Date": null,
        "mx_lead_Id": null,
        "mx_State_List": null,
        "mx_StateCus": null,
        "mx_StateCs": null,
        "mx_withothers": null,
        "mx_PhoneA_NuMBER": null,
        "mx_LeadHidden": null,
        "mx_Source_term": null,
        "mx_ModifiedTime": null,
        "mx_CreationTime": null,
        "NotableEvent": "Modified",
        "NotableEventdate": "2015-09-11 05:55:23.000",
        "SourceReferrer": "",
        "LastVisitDate": null,
        "OwnerIdName": "Syed Rizwan",
        "CreatedByName": "rizwan ali",
        "ModifiedByName": "rizwan ali",
        "IsStarredLead": "false"
    }
]

HTTP Response Code

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.