There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get a contact by vid

Last updated January 7, 2025

GET /contacts/v1/contact/vid/:vid/profile

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

crm.objects.contacts.read

The get a contact by vid endpoint returns information about a single contact by its ID (vid) for a given account. The contact's unique ID is stored in a field called 'vid,' which stands for 'visitor ID.'

Use case for this endpoint: An integration could use this endpoint to get all updates made to a HubSpot contact since its creation.

Response details

  • Returns a 404 is there is no contact with that vid.
Required parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
Contact ID Used in the request URL (see above) Unique identifier for a particular contact. In HubSpot's contact system, contact ID's are called "vid", as you can see in the API output below.
Optional parameters How to use Description
Property &property=x&property=y - Used in the request URL By default, all valued properties will be included. If you include the "property" parameter, then the returned data will only include the property or properties that you request. You can include this parameter multiple times to specify multiple properties. The lastmodifieddate and associatedcompanyid will always be included, even if not specified. Keep in mind that only properties that have a value will be included in the response, even if specified in the URL.
Property mode &propertyMode=x One of “value_only” or “value_and_history” to specify if the current value for a property should be fetched, or the value and all the historical values for that property. Default is “value_and_history”.
Form submission mode &formSubmissionMode=x One of “all”, “none”, “newest”, “oldest” to specify which form submissions should be fetched. Default is “all”.
List memberships &showListMemberships=x Boolean "true" or "false" to indicate whether current list memberships should be fetched for the contact. Default is true.

Example URL:  https://api.hubapi.com/contacts/v1/contact/vid/3234574/profile

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/contacts/v1/contact/vid/12627374/profile Example response: { "vid": 12627374, "canonical-vid": 12627374, "merged-vids": [], "portal-id": 62515, "is-contact": true, "properties": { "hs_email_optout_354586": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "num_unique_conversion_events": { "value": "0", "versions": [ { "value": "0", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 0, "selected": false } ] }, "hs_email_quarantined": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_analytics_revenue": { "value": "0.0", "versions": [ { "value": "0.0", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_social_num_broadcast_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "createdate": { "value": "1566329710917", "versions": [ { "value": "1566329710917", "source-type": "ANALYTICS", "source-id": "", "source-label": null, "timestamp": 1566329710917, "selected": false } ] }, "hs_email_recipient_fatigue_recovery_time": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_email_optout_5375287": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_email_optout": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_analytics_last_timestamp": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "last_login_site": { "value": "doba", "versions": [ { "value": "doba", "source-type": "ANALYTICS", "source-id": "04dba37d-125d-31fa-aca8-3ac1238e77f0", "source-label": null, "timestamp": 1566372681559, "selected": false } ] }, "hs_email_optout_6914043": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_analytics_num_visits": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_email_optout_5476312": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_social_linkedin_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_email_optout_6497985": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_analytics_last_visit_timestamp": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_social_last_engagement": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_analytics_source": { "value": "OFFLINE", "versions": [ { "value": "OFFLINE", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_email_domain": { "value": "profitzon.co.il", "versions": [ { "value": "profitzon.co.il", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 1566329710480, "selected": false } ] }, "hs_analytics_num_page_views": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_analytics_first_touch_converting_campaign": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "email": { "value": "invoice1@profitzon.co.il", "versions": [ { "value": "invoice1@profitzon.co.il", "source-type": "ANALYTICS", "source-id": "", "source-label": null, "timestamp": 1566329710480, "selected": false } ] }, "hs_email_optout_4744389": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hubspotscore": { "value": "0", "versions": [ { "value": "0", "source-type": "WAL_INCREMENTAL", "source-id": "csrsu-kafka@v1522746307447", "source-label": null, "timestamp": 1566329712193, "selected": false } ] }, "hs_analytics_first_visit_timestamp": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "lastmodifieddate": { "value": "1573629251761", "versions": [ { "value": "1573629251761", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 1573629251761, "selected": false } ] }, "hs_analytics_first_timestamp": { "value": "1566329710480", "versions": [ { "value": "1566329710480", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_email_optout_5583924": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_social_google_plus_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_analytics_last_touch_converting_campaign": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_lifecyclestage_subscriber_date": { "value": "1566329710917", "versions": [ { "value": "1566329710917", "source-type": "ANALYTICS", "source-id": "", "source-label": null, "timestamp": 1566329710917, "selected": false } ] }, "hs_email_optout_4447431": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_email_optout_230318": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_email_optout_1281663": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_analytics_average_page_views": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_social_facebook_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_predictivescoringtier": { "value": "tier_2", "versions": [ { "value": "tier_2", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1571454873131, "selected": false }, { "value": "tier_1", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1568965562697, "selected": false }, { "value": "tier_2", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1567399848473, "selected": false }, { "value": "tier_1", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1566329756670, "selected": false } ] }, "hs_is_contact": { "value": "true", "versions": [ { "value": "true", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 0, "selected": false } ] }, "hs_predictivecontactscore_v2": { "value": "1.23", "versions": [ { "value": "1.23", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1573629248758, "selected": false }, { "value": "1.53", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1572235132094, "selected": false }, { "value": "1.77", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1570866795863, "selected": false }, { "value": "3.67", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1569556356256, "selected": false }, { "value": "2.45", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1566381906383, "selected": false }, { "value": "2.58", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1566374641807, "selected": false }, { "value": "2.48", "source-type": "CALCULATED", "source-id": null, "source-label": "HubSpot Predictive Contact Scoring Model", "timestamp": 1566329756670, "selected": false } ] }, "num_conversion_events": { "value": "0", "versions": [ { "value": "0", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 1566329710917, "selected": false } ] }, "hs_object_id": { "value": "12627374", "versions": [ { "value": "12627374", "source-type": "CALCULATED", "source-id": null, "source-label": null, "timestamp": 1566329710917, "selected": false } ] }, "hs_analytics_num_event_completions": { "value": "7", "versions": [ { "value": "7", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566381860155, "selected": false }, { "value": "6", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566381808531, "selected": false }, { "value": "5", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566378705011, "selected": false }, { "value": "4", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566374618639, "selected": false }, { "value": "3", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566373604987, "selected": false }, { "value": "2", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566372802919, "selected": false }, { "value": "1", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_social_twitter_clicks": { "value": "0", "versions": [ { "value": "0", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_analytics_source_data_2": { "value": "", "versions": [ { "value": "", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "hs_analytics_source_data_1": { "value": "ANALYTICS", "versions": [ { "value": "ANALYTICS", "source-type": "ANALYTICS", "source-id": "ContactAnalyticsDetailsUpdateWorker", "source-label": null, "timestamp": 1566329713264, "selected": false } ] }, "lifecyclestage": { "value": "subscriber", "versions": [ { "value": "subscriber", "source-type": "ANALYTICS", "source-id": "", "source-label": null, "timestamp": 1566329710917, "selected": false } ] }, "hs_email_optout_5479310": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] }, "hs_email_optout_2849": { "value": "", "versions": [ { "value": "", "source-type": "EMAIL", "source-id": "Updated in response to a contact being created.", "source-label": "invoice1@profitzon.co.il", "timestamp": 1566329710917, "selected": false } ] } }, "form-submissions": [], "list-memberships": [], "identity-profiles": [ { "vid": 12627374, "saved-at-timestamp": 1566329710938, "deleted-changed-timestamp": 0, "identities": [ { "type": "EMAIL", "value": "invoice1@profitzon.co.il", "timestamp": 1566329710480, "is-primary": true }, { "type": "LEAD_GUID", "value": "8c8cd830-b618-4044-91bc-c1f3bf00ca9b", "timestamp": 1566329710924 } ] } ], "merge-audits": [] }
import requests import json url = "https://api.hubapi.com/contacts/v1/contact/vid/12627374/profile?hapikey=demo" headers = {} r = requests.get(url = url, headers = headers) print(r.text)
var request = require("request"); var options = { method: 'GET', url: 'https://api.hubapi.com/contacts/v1/contact/vid/12627374/profile', qs: { hapikey: 'demo' } } request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });