For a given portal, return information about a single lead.
| Required Parameters | How to use | Description |
|---|---|---|
| HubSpot OAuth Access Token | access_token=X - Used in the request URL | The HubSpot API key for the portal that you're making the call for. |
| Optional Parameters | How to use | Description |
|---|---|---|
| Lead GUID | Used in the request URL | Unique identifier for a particular lead. This is only required though if you don't also include any of the optional parameters below ("conversionEventGuid", "email" or "userToken"), which you can use to search for a lead as well. If you include a valid User Token, then we'll return a lead to you via that parameter as well (see below for that parameter). |
| Email Address | &email=X - Used in the request URL | The email address of the lead (if not unique, this returns the lead with that email that converted first) |
| Conversion Event GUID | &conversionEventGuid=X - Used in the request URL | A GUID for a conversion event associated with the lead. This conversion event gets returned to you when you create a new lead in HubSpot. See the create a lead method for more detail on this. |
| User Token | &userToken=X - Used in the request URL | The tracking cookie token value used for HubSpot lead activity tracking. |
Example JSON output:
[
{
"address": "",
"analyticsDetails": {
"allViewsImported": true,
"countsModifiedAt": 1279853227000,
"firstVisitAt": 1275710855000,
"id": "8a41f2f22906b93a012906b9438f0008",
"lastPageViewAt": 1275710855000,
"lastVisitAt": 1275710855000,
"leadGuid": "8a41f2f22906b93a012906b9438f0008",
"leadId": 830918,
"pageViewCount": 2,
"portalId": 62515,
"userToken": "13067f6bfbd542098793fda0542a93f9",
"visitCount": 2
},
"city": "",
"closedAt": 1272997000000,
"company": "",
"country": "",
"crmDetails": {
"annualRevenue": 0,
"closeProbability": 1,
"crmType": 1,
"estimatedRevenue": 0,
"id": "8a41f2f22906b93a012906b9438f0008",
"nextAction": "",
"nextActionAssignedTo": 0,
"nextActionAssignedToEmail": "",
"nextActionDue": 0,
"numEmployees": 0,
"status": "Open"
},
"customerStatusModifiedAt": 0,
"eligibleForEmail": true,
"email": "info@hubspot.com",
"emailBounced": false,
"emailOptOut": false,
"fax": "",
"firstCampaign": "",
"firstName": "HubSpot",
"firstRefDomain": "",
"firstReferrer": "http://www.hubspot.com/",
"firstURL": "http://demo.hubapi.com/",
"firstVisitSetAt": 1275718091660,
"foundVia": "Referrals",
"fullFoundViaString": "Referrals - hubspot.com",
"guid": "8a41f2f22906b93a012906b9438f0008",
"id": "8a41f2f22906b93a012906b9438f0008",
"imported": false,
"industry": "",
"insertedAt": 1275718091660,
"ipAddress": "184.73.15.169",
"isCustomer": true,
"isDeleted": false,
"jobTitle": "",
"lastConvertedAt": 1275718058000,
"lastModifiedAt": 1320349394338,
"lastName": "Internet Marketing Specialists",
"leadConversionEvents": [
{
"convertDate": 1275718058000,
"formGuid": "fcbd0c1834a14534adfc1f0197801048",
"formId": 25349,
"formName": "Contact Us",
"formSubmissionValues": [
{
"conversionGuid": "15e857315cce44448c8abd9fb33aa651",
"convertDate": 1275718058000,
"fieldLabel": "First Name",
"fieldName": "FirstName",
"fieldValue": "HubSpot",
"formGuid": "fcbd0c1834a14534adfc1f0197801048",
"formId": 25349,
"formName": "Contact Us",
"id": 767892282,
"leadGuid": "8a41f2f22906b93a012906b9438f0008",
"portalId": 62515
},
{
"conversionGuid": "15e857315cce44448c8abd9fb33aa651",
"convertDate": 1275718058000,
"fieldLabel": "Last Name",
"fieldName": "LastName",
"fieldValue": "Internet Marketing Specialists",
"formGuid": "fcbd0c1834a14534adfc1f0197801048",
"formId": 25349,
"formName": "Contact Us",
"id": 767892292,
"leadGuid": "8a41f2f22906b93a012906b9438f0008",
"portalId": 62515
},
{
"conversionGuid": "15e857315cce44448c8abd9fb33aa651",
"convertDate": 1275718058000,
"fieldLabel": "Email (we will keep your email completely private)",
"fieldName": "Email",
"fieldValue": "info@hubspot.com",
"formGuid": "fcbd0c1834a14534adfc1f0197801048",
"formId": 25349,
"formName": "Contact Us",
"id": 767892312,
"leadGuid": "8a41f2f22906b93a012906b9438f0008",
"portalId": 62515
},
{
"conversionGuid": "15e857315cce44448c8abd9fb33aa651",
"convertDate": 1275718058000,
"fieldLabel": "Message",
"fieldName": "Message",
"fieldValue": "This is a sample lead, but if you want help getting more leads, give us a call at 1-888-HUBSPOT, ext. #1",
"formGuid": "fcbd0c1834a14534adfc1f0197801048",
"formId": 25349,
"formName": "Contact Us",
"id": 767892332,
"leadGuid": "8a41f2f22906b93a012906b9438f0008",
"portalId": 62515
}
],
"guid": "15e857315cce44448c8abd9fb33aa651",
"id": "15e857315cce44448c8abd9fb33aa651",
"leadGuid": "8a41f2f22906b93a012906b9438f0008",
"pageName": "Landing Pages",
"pageType": "Form",
"pageUrl": "http://demohubapi.web6.hubspot.com/landing-pages/Default.aspx?RewriteStatus=1",
"portalId": 62515
}
],
"leadCustomerStatusModifyLogs": [
{
"id": 4135752,
"insertedAt": 1303305845158,
"previousState": false
}
],
"leadDeleteLogs": [],
"leadId": 830918,
"leadJsonLink": "https://api.hubapi.com/leads/v1/lead/8a41f2f22906b93a012906b9438f0008",
"leadLink": "https://app.hubspot.com/leads/app/lead?portalId=62515&guid=8a41f2f22906b93a012906b9438f0008",
"leadNurturingActive": true,
"leadNurturingCampaignId": 77244,
"message": "This is a sample lead, but if you want help getting more leads, give us a call at 1-888-HUBSPOT, ext. #1",
"numConversionEvents": 1,
"phone": "",
"portalId": 62515,
"publicLeadLink": "https://app.hubspot.com/leads/public/leadDetails?portalId=62515&leadToken=KmAEjOwsiFAa0h1fn6ce%2Bw%3D%3D",
"rawScore": 140,
"salutation": "",
"score": 99.96,
"sourceId": 2,
"sourceValue1": "hubspot.com",
"sourceValue2": "",
"sourceValueModifiedAt": 1320349394338,
"state": "",
"twitterHandle": "",
"userToken": "13067f6bfbd542098793fda0542a93f9",
"website": "",
"zip": ""
}
]
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers